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.

Sign up for GitHub

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

Update DEVELOPER_GUIDE #297

Merged
merged 4 commits into from
Mar 18, 2024
Merged

Update DEVELOPER_GUIDE #297

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c5afa70
updated developer guide
nkaenzig Mar 18, 2024
47a7f23
Merge branch 'main' into 296-update-developer-guide
ioangatop Mar 18, 2024
825f2e9
added cmake install instructions
nkaenzig Mar 18, 2024
ded935f
Merge remote-tracking branch 'origin/main' into 296-update-developer-…
nkaenzig Mar 18, 2024
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
26 changes: 14 additions & 12 deletions docs/DEVELOPER_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,24 @@
# Developer Guide

## Installation

To contribute any feature to EVA, you must install from source.
## Setting up a DEV environment

We use [PDM](https://pdm-project.org/latest/) as a package and dependency manager.
You can set up a local python environment for development as follows:
1. Install package and dependency manager PDM following the instructions [here](https://pdm-project.org/latest/#other-installation-methods).
2. Run `pdm install -G dev` to install the development dependencies. This will create a virtual environment in `eva/.venv`.
3. Run `pdm run python` to run a Python script or start an interactive Python shell within the context of the PDM-managed project environment. Alternatively, you can also activate the venv manually with `source .venv/bin/activate`.


PDM quick guide:
- `pdm lock -G all -G vision -G lint -G test -G dev` to generate or update the pdm.lock file including the specified groups.
- `pdm install -G all` to install all groups locked in the lockfile.
- `pdm install -G vision` to install dependencies only from vision group.
- `pdm update -G all` to update all dependencies in the lock file.
- `pdm add <package-name>` to add a package.
- `pdm remove <package-name>` to remove a package.
- `pdm add -G vision <package-name>` to add a package to eva[vision].
- `pdm remove -G vision <package-name>` to remove a package from eva[vision].
## Adding new dependencies

Add a new dependency to the `core` submodule:<br>
`pdm add <package_name>`

Add a new dependency to the `vision` submodule:<br>
`pdm add -G vision <package_name>`

After adding a new dependency, you also need to update the `pdm.lock` file:<br>
`pdm update`

For more information about managing dependencies please look [here](https://pdm-project.org/latest/usage/dependency/#manage-dependencies).

Expand All @@ -35,3 +36,4 @@ Commands:
- `nox -s lint` to run the code lining tests.
- `nox -s check` to run the type-annotation tests.
- `nox -s test` to run the unit tests.
- `nox -s test -- tests/eva/metrics/test_average_loss.py` to run specific tests