Skip to content

Commit

Permalink
readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
KristinaGomoryova committed Jul 15, 2024
1 parent b329075 commit 00eef7c
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 15 deletions.
33 changes: 19 additions & 14 deletions README.dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,31 @@

If you're looking for user documentation, go [here](README.md).

## Development install
## Package installation

```shell
# Create a virtual environment, e.g. with
python -m venv env
To create a new environment, use the micromamba:

```console
micromamba create rcx-tk
micromamba activate rcx-tk
```
To install all dependencies specified in the `pyproject.toml` file, use poetry:

# activate virtual environment
source env/bin/activate
```console
poetry install
```

# make sure to have a recent version of pip and setuptools
python -m pip install --upgrade pip setuptools
A command line interface was also implemented using Click, so the package can be run by either using python3:

# (from the project root directory)
# install rcx_tk as an editable package
python -m pip install --no-cache-dir --editable .
# install development dependencies
python -m pip install --no-cache-dir --editable .[dev]
```console
python3 <path-to-__main.py__> --method='' <path-to-input-data> <path-to-output-data>
```

Afterwards check that the install directory is present in the `PATH` environment variable.
or using poetry:

```console
poetry run rcx_tk --method='' <file-path-to-input-data> <file-path-to-output-data>
```

## Running the tests

Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,11 @@ cd rcx-tk
python -m pip install .
```

Upon installation, the tool can be run also using the poetry:
Upon installation, the tool can be run also using either the python3 or poetry:

```console
python3 <path-to-__main.py__> --method='' <path-to-input-data> <path-to-output-data>
```

```console
poetry run rcx_tk --method='' <file-path-to-input-data> <file-path-to-output-data>
Expand Down

0 comments on commit 00eef7c

Please sign in to comment.