Skip to content

Commit

Permalink
chore: fix installation
Browse files Browse the repository at this point in the history
  • Loading branch information
incebellipipo committed May 24, 2024
1 parent cd6edc2 commit 610c998
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 1 deletion.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,20 @@ A python library for solving the control allocation problem for marine craft wit

## Installation

### Pip

1. Install the package using git from the master branch using

```bash
pip install git+https://github.com/incebellipipo/skadipy.git@master
```

2. Test the installation
```bash
python -c "import skadipy; print(skadipy.__version__)"
```

### Virtual Environment
1. Clone the package and create a virtual environment.
```bash
python -m venv venv
Expand Down
5 changes: 4 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[build-system]
requires = ["setuptools>=64", "setuptools_scm>=8"]
requires = ["setuptools>=64", "setuptools_scm>=8", "wheel"]
build-backend = "setuptools.build_meta"


Expand All @@ -24,3 +24,6 @@ dependencies = {file = ["requirements.txt"]}
[tool.setuptools_scm]
version_file = "src/skadipy/__version__.py"
version_scheme = 'post-release'

[tool.setuptools.packages.find]
where = ["src"]
Empty file added setup.cfg
Empty file.

0 comments on commit 610c998

Please sign in to comment.