Skip to content

Commit 99bfdc6

Browse files
committed
dev setup + version
1 parent 7e9255d commit 99bfdc6

File tree

3 files changed

+23
-3
lines changed

3 files changed

+23
-3
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# COMPAS RhinoVAULT
22

33
> [!NOTE]
4-
> The current version of COMPAS-RhinoVAULT on the Yak package server is `0.2.5`.
4+
> The current version of COMPAS-RhinoVAULT on the Yak package server is `0.3`.
55
> Note that this is still a pre-release!
66
77
![RhinoVAULT](compas-RV.jpg)
@@ -18,4 +18,15 @@ If you find a bug or if you have a problem with running the code, please file an
1818

1919
## Developer Guide
2020

21-
Under construction...
21+
1. Create a dev environment with `conda` using `environment.yml`.
22+
23+
2. Overwrite all requirements of `requirements.txt` with editable source installs.
24+
25+
3. Overwrite all requirements in the site-env `rhinovault` in Rhino with editable installs from local source.
26+
For example, for `compas`
27+
28+
```bash
29+
conda activate rhinovault-dev
30+
cd path/to/local/compas
31+
python -m pip install -e . --target ~/.rhinocode/py39-rh8/site-envs/rhinovault-828OGCEY
32+
```

environment.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name: rhinovault-dev
2+
channels:
3+
- conda-forge
4+
dependencies:
5+
- python=3.9
6+
- pip
7+
- compas
8+
- pip:
9+
- -e .[dev]

requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
compas >= 2.5
22
compas_fd >= 0.5
3-
compas_rui >=0.3
3+
compas_rui >=0.3.1
44
compas_session >=0.4.1
55
compas_tna >= 0.5
66
# compas_pattern

0 commit comments

Comments
 (0)