Skip to content

Commit

Permalink
Installation: Support for editable installations of icedyno
Browse files Browse the repository at this point in the history
  • Loading branch information
JuLieAlgebra committed Mar 12, 2024
1 parent d4861a6 commit 41c5020
Show file tree
Hide file tree
Showing 5 changed files with 608 additions and 410 deletions.
5 changes: 5 additions & 0 deletions docs/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ To set up the automatic linters (that run every time you commit your work), you

![install_pre_commit](images/install_pre_commit.png)

Finish the installation proces with:
```pixi run pip install -e .```

If you skip this last step, you will **not** be able to import `icedyno` as an installed python library.

## Testing the set up
If you activated the pixi environment, type `pytest`. If not, type `pixi run pytest`. You should have one dummy test that runs on that command.

Expand Down
5 changes: 5 additions & 0 deletions docs/workflow.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# IceDyno Dev Workflow

This is where we should document how we should merge/rebase/squash/etc and things we should know while working.

## Resolving rebase conflicts with pixi.lock
You will only enounter this if you have added/removed dependencies and main has received commits since you first branched that included new/removed dependencies.

If you encounter this, please make sure that the pixi.toml contains the (non-duplicated) additions from your commits and main's, then delete the pixi.lock and run `pixi install` to regnerate the lock file given both sets of dependencies.
Loading

0 comments on commit 41c5020

Please sign in to comment.