Skip to content

Commit 9e4efa3

Browse files
committed
added notes for jupyter kernel and modified dev install to use pip
1 parent ebf48d9 commit 9e4efa3

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,27 @@ See [this notebook](notebooks/python_api_examples.ipynb) for usage examples.
88

99
![Data Model Diagram](model_diagram.png)
1010

11+
1112
## Development Notes
1213

1314
Create a conda env with all the dependencies including Jupyter:
1415

1516
conda env create -f environment.yml
1617
conda activate neuronbridge-python
1718

19+
Then install it as a Jupyter kernel:
20+
21+
python -m ipykernel install --user --name=neuronbridge-python
22+
23+
1824
### Install for development
1925

2026
You can install the module for development like this:
2127

2228
conda create --name neuronbridge-python python=3.8
2329
conda activate neuronbridge-python
24-
python setup.py develop
30+
pip install -e .
31+
2532

2633
### Useful shell commands
2734

@@ -41,6 +48,7 @@ Run the unit tests:
4148

4249
pytest tests
4350

51+
4452
### Publishing a new release
4553

4654
1) Update the version in setup.py
@@ -53,6 +61,7 @@ Run the unit tests:
5361

5462
twine upload dist/*
5563

64+
5665
### Running validation using Ray
5766

5867
You can run validation multithreaded on a single machine like this:

0 commit comments

Comments
 (0)