Skip to content

Commit

Permalink
Updated README for using registered CORBITS
Browse files Browse the repository at this point in the history
  • Loading branch information
eford committed Jun 4, 2019
1 parent 54878a3 commit 6befc6d
Showing 1 changed file with 2 additions and 9 deletions.
11 changes: 2 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Welcome to the ExoplanetsSysSim package for generating planetary systems and simulating observations of those systems with a transit survey. Currently, SysSim focuses on NASA's Kepler mission, but we've aimed to develop a generic framework that can be applied to other surveys (e.g., K2, TESS, PLATO, LSST, etc.).

# How to install ExoplanetsSysSim:
* Make sure you have julia (v0.7 or greater) installed. It's been tested on v1.0.2.
* Make sure you have julia (v0.7 or greater) installed. It's been tested on v1.1.0.

* Make sure you have a recent git and [git-lfs](https://git-lfs.github.com/) installed.
If you're using ICS-ACI, then do this by running the following for each shell (or putting it in your .bashrc)
Expand Down Expand Up @@ -38,12 +38,6 @@ One ICS-ACI, it's useful to set your JULIA_DEPOT_PATH to be in your work directo
export JULIA_DEPOT_PATH=~/work/.julia
```

* Run julia and install eford's version of the CORBITS.jl Julia package (not the registered package).
```julia
using Pkg
Pkg.add(PackageSpec(url="https://github.com/eford/CORBITS.jl"))
```

* Run julia and install the ExoplanetsSysSim repo as a Julia package. If you will only be using it as is, then you can use the repo under ExoJulia. However, if you may be modifying source code in the ExoplanetsSysSim directory itself, then please fork your own version on github and develop that version instead. For example,
```julia
Pkg.develop(PackageSpec(url="[email protected]:ExoJulia/ExoplanetsSysSim.jl.git"))
Expand All @@ -68,12 +62,11 @@ include(joinpath(dirname(pathof(ExoplanetsSysSim)),"..","test","runtests.jl"))
# How to use SysSim
- Install ExoplanetsSysSim (see above)
- Create your own repository containing code that will call ExoplanetsSysSim
- Make it a Julia project by adding dependancies, including eford's CORBITS and ExoplanetsSysSim (see above)
- Make it a Julia project by adding dependancies, including ExoplanetsSysSim.
- Make your project depend on your development directory for ExoplanetsSysSim. Since you've already installed ExoplanetSysSim, then Julia should find and reused the code in the dev directory rather than reinstalling it.
```julia
using Pkg
Pkg.activate(".")
Pkg.add(PackageSpec(url="https://github.com/eford/CORBITS.jl"))
Pkg.instantiate()
Pkg.develop(PackageSpec(url="[email protected]:ExoJulia/ExoplanetsSysSim.jl.git"))
```
Expand Down

2 comments on commit 6befc6d

@eford
Copy link
Member Author

@eford eford commented on 6befc6d Jun 4, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/1169

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if Julia TagBot is installed, or can be done manually through the github interface, or via:

git tag -a v1.0.0 -m "<description of version>" 6befc6da120690a554875d87cc46c840e1d10ab7
git push origin v1.0.0

Please sign in to comment.