Skip to content

Commit f3d88e2

Browse files
authored
Merge pull request #85 from NeuroML/docs/add-dep-info
docs: add information about necessary dependencies
2 parents b8a666b + c01ec45 commit f3d88e2

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,25 @@ Builds on: [libNeuroML](https://github.com/NeuralEnsemble/libNeuroML) & [PyLEMS]
1818
Installation
1919
------------
2020

21-
### Pip
21+
### Dependencies
22+
23+
pyNeuroML relies on additional software to carry out its functions:
24+
25+
- Java Runtime environment (JRE)
26+
- dot (from [Graphviz](http://graphviz.org/))
27+
- lxml
2228

23-
pyNeuroML can be installed with pip:
29+
On most Linux systems, these can be installed using the default package manager.
30+
On Ubuntu based distributions:
2431

25-
sudo pip install pyneuroml
32+
sudo apt-get install python-lxml graphviz openjdk-11-jdk
33+
34+
35+
### Pip
2636

27-
You may need to install lxml on Linux with:
37+
pyNeuroML can be installed with pip (preferably in a [virtual environment](https://docs.python.org/3/tutorial/venv.html)):
2838

29-
sudo apt-get install python-lxml
39+
pip install pyneuroml
3040

3141
### Fedora
3242

@@ -36,6 +46,7 @@ Fedora users can install pyNeuroML using the following commands:
3646
sudo dnf copr enable @neurofedora/neurofedora-extra
3747
sudo dnf install python3-pyneuroml
3848

49+
This will also pull in all the necessary dependencies (Java, lxml, graphviz).
3950
Please see the [project documentation](https://docs.fedoraproject.org/en-US/neurofedora/copr/) for more information.
4051

4152
### Installation from source

0 commit comments

Comments
 (0)