-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated README for using registered CORBITS
- Loading branch information
Showing
1 changed file
with
2 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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) | ||
|
@@ -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")) | ||
|
@@ -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")) | ||
``` | ||
|
6befc6d
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@JuliaRegistrator register
6befc6d
There was a problem hiding this comment.
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: