Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Installation: Support for editable installations of icedyno #48

Merged
merged 2 commits into from
Mar 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading