You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+32-5
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,43 @@
4
4
5
5
Fortran core of TRACMASS + Python wrapping around the outside.
6
6
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)
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 .`).
7
34
8
35
## To get the code
9
36
10
37
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:
13
40
`git clone https://github.com/kthyng/tracpy.git`
14
41
1. Install the package globally:
15
42
`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:
17
44
`pip install --user .`
18
45
19
46
@@ -23,10 +50,10 @@ This makes the package an editable install so that it can be updated with future
0 commit comments