-
Notifications
You must be signed in to change notification settings - Fork 4
Maint/deprecate requirements txt #467
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
Changes from all commits
b0341bf
fc7af09
027dba2
865fc69
be5f707
1d088d0
ae9c4e4
d00c05c
6cd0829
058338c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,15 +19,14 @@ An algorithm to pack molecular recipes | |
| git clone [email protected]:mesoscope/cellpack.git | ||
| cd cellpack | ||
| ``` | ||
| 1. Create a new virtual environment and activate it. | ||
| 3. Create a new virtual environment and activate it. | ||
| ```bash | ||
| python -m venv .venv | ||
| source .venv/bin/activate | ||
| ``` | ||
| 1. Install the required packages for your operating system. Replace `linux` with `macos` or `windows` as appropriate. | ||
| 4. Install the package and its dependencies from `pyproject.toml`. | ||
| ```bash | ||
| pip install --upgrade pip | ||
| pip install -r requirements/linux/requirements.txt | ||
| pip install -e . | ||
| ``` | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,12 +15,11 @@ Ready to contribute? Here's how to set up `cellpack` for local development. | |
| git clone [email protected]:{your_name_here}/cellpack.git | ||
| ``` | ||
|
|
||
| 3. Install the project in editable mode by following installation instructions [here](./docs/INSTALL.md). (It is also recommended to work in a virtual environment): | ||
| 3. Install the project in editable mode by following installation instructions [here](./INSTALLATION.md). (It is also recommended to work in a virtual environment): | ||
|
|
||
| ```bash | ||
| cd cellpack/ | ||
| pip install -r requirements/linux/requirements.txt | ||
| pip install -e .[dev] | ||
| uv sync | ||
|
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. to address copilot's review comment(slightly out of scope): |
||
| ``` | ||
|
|
||
| 4. Create a branch for local development: | ||
|
|
@@ -51,7 +50,7 @@ Ready to contribute? Here's how to set up `cellpack` for local development. | |
|
|
||
| ### Contributing cheat sheet | ||
|
|
||
| 1. `pip install -e .[dev]` | ||
| 1. `uv sync` | ||
|
|
||
| This will install your package in editable mode with all the required development | ||
| dependencies (i.e. `tox`). | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
initially I used
pip install ".[server]", but that resolves fresh from PyPI on each build which means rebuilds could pick up different versions. Switching touv synckeeps the install pinned touv.lock, giving us more consistent builds.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just tried running this locally and it worked perfectly!