Skip to content

Commit 6760dff

Browse files
committed
Updated installation instructions
1 parent 90688db commit 6760dff

File tree

1 file changed

+7
-22
lines changed

1 file changed

+7
-22
lines changed

docs/installation.md

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Installation
22

3-
## Users
4-
53
Delphi is under active development in an academic, rather than a
64
commercial setting, so we do not have the resources to test it out on
75
the Windows operating system, or provide a one-step/one-click setup
@@ -43,14 +41,6 @@ Here are the steps for installation.
4341
```
4442

4543

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-
```
5444

5545
### Graphviz installation notes
5646

@@ -124,28 +114,23 @@ delphi project. This can be set in one of two places:
124114
```
125115

126116
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`).
128118
The delphi.db name must appear at the end of the path, for example:
129119

130120
```bash
131121
export DELPHI_DB="/Users/claytonm/Documents/repository/delphi_db/delphi.db"
132122
```
133123

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):
134126

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+
```
145130

146131
### Building documentation
147132

148-
(This requies you have performed the installation for developers, above.)
133+
(This requires you have performed the installation for developers, above.)
149134
To build and view the documentation, run the following commands from the root of
150135
the repository:
151136

0 commit comments

Comments
 (0)