Skip to content

Commit 48704e6

Browse files
committed
updated readme
1 parent 108c558 commit 48704e6

File tree

1 file changed

+32
-5
lines changed

1 file changed

+32
-5
lines changed

README.md

+32-5
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,43 @@
44

55
Fortran core of TRACMASS + Python wrapping around the outside.
66

7+
## Set up for TracPy
8+
9+
I recommend setting up a good python environment for this work, as follows:
10+
11+
1. Install miniconda:
12+
* download file from Continuum
13+
* `bash [download file]`
14+
1. Set `conda-forge` to be highest-priority channel (this helps the geography libraries like cartopy that connect to the geos library be all consistent)
15+
* `conda config --add channels conda-forge --force`
16+
1. Create environment called "tracpy" (some of the listed packages are required and some are just suggested because they are useful)
17+
* `conda create --name tracpy python=3.6 cartopy matplotlib ipython netCDF4 fiona shapely pandas xarray cmocean jupyter scipy numpy seaborn --yes`
18+
1. Need to also have `octant`:
19+
* `git clone https://github.com/hetland/octant.git`
20+
* `cd octant`
21+
* `pip install -e .`
22+
1. Make sure you installed `tracpy`:
23+
* `pip install -e .`
24+
1. To use environment:
25+
* `source activate tracpy`
26+
1. To stop using environment (in a given terminal window):
27+
* `source deactivate`
28+
1. To install more packages later:
29+
* `conda install [package name]`
30+
1. Run the manual in `/docs` with `jupyter notebook`
31+
32+
33+
If you want to install locally, you can generally use the `--user` flag (e.g. `pip install --user .`).
734

835
## To get the code
936

1037
1. Make your new TracPy directory and change directories into it.
11-
1. Clone the TracPy repository from GitHub.
12-
In the command prompt, type:
38+
1. Clone the TracPy repository from GitHub.
39+
In the command prompt, type:
1340
`git clone https://github.com/kthyng/tracpy.git`
1441
1. Install the package globally:
1542
`pip install -e .`
16-
This makes the package an editable install so that it can be updated with future additions to TracPy. Note that a required package is [octant](https://github.com/hetland/octant). To instead install the package locally:
43+
This makes the package an editable install so that it can be updated with future additions to TracPy. Note that a required package is [octant](https://github.com/hetland/octant). To instead install the package locally:
1744
`pip install --user .`
1845

1946

@@ -23,10 +50,10 @@ This makes the package an editable install so that it can be updated with future
2350
1. Update your GitHub repository.
2451
`git pull`
2552
1. Edit your install of TracPy.
26-
`pip install -e .`
53+
`pip install -e .`
2754
or
2855
`pip install --force-reinstall -e .`
29-
or, for local installation:
56+
or, for local installation:
3057
`pip install --ignore-installed --user .`
3158

3259

0 commit comments

Comments
 (0)