|
1 | 1 | # Installation
|
2 | 2 |
|
3 |
| -## Users |
4 |
| - |
5 | 3 | Delphi is under active development in an academic, rather than a
|
6 | 4 | commercial setting, so we do not have the resources to test it out on
|
7 | 5 | the Windows operating system, or provide a one-step/one-click setup
|
@@ -43,14 +41,6 @@ Here are the steps for installation.
|
43 | 41 | ```
|
44 | 42 |
|
45 | 43 |
|
46 |
| -## Developers |
47 |
| - |
48 |
| -If you are developing Delphi and want to run tests or compile the |
49 |
| -documentation, then also do the following (from the root of Delphi): |
50 |
| - |
51 |
| -``` |
52 |
| -pip install -e .[test,docs] |
53 |
| -``` |
54 | 44 |
|
55 | 45 | ### Graphviz installation notes
|
56 | 46 |
|
@@ -124,28 +114,23 @@ delphi project. This can be set in one of two places:
|
124 | 114 | ```
|
125 | 115 |
|
126 | 116 | Then set the variable enviornment (again, may be done within your bash
|
127 |
| - resource file or the virtual envrionment `project.pth`). |
| 117 | + resource file or the virtual environment `project.pth`). |
128 | 118 | The delphi.db name must appear at the end of the path, for example:
|
129 | 119 |
|
130 | 120 | ```bash
|
131 | 121 | export DELPHI_DB="/Users/claytonm/Documents/repository/delphi_db/delphi.db"
|
132 | 122 | ```
|
133 | 123 |
|
| 124 | +If you are developing Delphi and want to run tests or compile the |
| 125 | +documentation, then also do the following (from the root of Delphi): |
134 | 126 |
|
135 |
| -- *Optional*: If you are working on program analysis, you may want to |
136 |
| -optionally set the following environment variables as well (again, in |
137 |
| -.bash_profile/.bashrc or viritual environment projects.pth). |
138 |
| - |
139 |
| - - `DSSAT_REPOSITORY`: This should point to your local checkout of |
140 |
| - the [DSSAT](https://github.com/DSSAT/dssat-csm) repository. |
141 |
| - |
142 |
| - - `ED2_REPOSITORY`: This should point to your local checkout of the |
143 |
| - [Ecosystem Demography Model](https://github.com/EDmodel/ED2) |
144 |
| - repository. |
| 127 | +``` |
| 128 | +pip install -e .[test,docs] |
| 129 | +``` |
145 | 130 |
|
146 | 131 | ### Building documentation
|
147 | 132 |
|
148 |
| -(This requies you have performed the installation for developers, above.) |
| 133 | +(This requires you have performed the installation for developers, above.) |
149 | 134 | To build and view the documentation, run the following commands from the root of
|
150 | 135 | the repository:
|
151 | 136 |
|
|
0 commit comments