rvspectml/rvspectml-overview

README for RvSpectML project

Packages & Repositories in the RvSpectML ecosystem include:

• Packages:

  • General Purpose:

    • RvSpectML.jl: Single package to install that provide most functionality (excluding plotting)

    

    • RvSpectMLBase.jl: Base package to be imported by other members of RvSpectML ecosystem. Provides common data types and methods. Aims to minimize dependancies on other packages.¹

    

    • EchelleInstruments.jl: Instrument-speciifc code for RvSpectML. Currently supports NEID and EXPRES. Pull requests for other instruments are encouraged.¹

    

    • EchelleCCFs.jl: Computes Cross Correlation Functions (CCFs) with an anlytic mask using RvSpectML. (Currently, includes basic code for measuring RVs from CCFs, but this feature may be moved into a separate pacakge in the future.) ¹

    
    

  • Specific algorithms:

    • Scalpels.jl: Scalpels algorithm to separate shift and shape-induced RVs.^1,2

    • GPLinearODEMaker.jl: Computes the likelihood (and derivatives) of multivariate Gaussian processes (GP) that are composed of a linear combination of a univariate GP and its derivatives.²
      
      

    • GLOM_RV_Example: Example applying GPLinearODEMaker.jl to model spectroscopic timeseries. ^2,3,4

  • Scripts using/supporting RvSpectML:

    • NeidArchive.jl: Julia wrapper for API to query/download data from Neid archives. ²

    • NeidSolarScripts.jl: Scripts to analyze NEID Sun-as-a-star observations. ^3,4

    • RvSpectMLPlots.jl: Plotting functions/scripts/notebooks that use RvSpectML.³
      

    • Experimental.jl: Repo for multiple pieces of code that are still in the development/research/experimental/untested stage.^3,4

How To:

• Report a problem/request a feature: Create an issue in the relevant github repository
• Create a new package with similar settings
• Cite RvSpectML: For now, you can just give the url for packages you use and the version number. Or let us know, we'll create a DOI.
• Cite GPLinearODEMaker.jl or GLOM_RV_Example: .

Footnotes on packages/repositories:

Footnotes

1. Please try to minimize breaking changes, and make sure any pull requests result in passing tests. If you add types or methods, then please consider adding associated documentation and tests for your pull request. ↩ ↩² ↩³ ↩⁴

2. This pacakge does not depend on RvSpectMLBase (or other RvSpectML repos), but can be easily called by other packages in the RvSpectML ecosystem. ↩ ↩² ↩³ ↩⁴

3. Expect that there will be breaking changes (e.g., renaming functions, changing function arguements, moving code to different modules) in this package. Once code for some purpose has stabilized and there are appropriate tests, we will consider whether it should become its own package or be incorporated into one of our other stable packages. ↩ ↩² ↩³ ↩⁴

4. This package is not yet registerd in Julia's general registry. ↩ ↩² ↩³