update project files

README.md

@@ -20,18 +20,11 @@ Visit our [**website**](https://vopy.readthedocs.io/en/latest/) to see tutorials
 
 ### Setup
 
-For requirements, see [requirements.txt](requirements.txt) or [environment.yml](environment.yml).
-
 Installation using pip:
 ```bash
 pip install vopy
 ```
 
-<!-- To setup a proper environment:
-```setup
-conda env create --name vo --file environment.yml
-``` -->
-
 #### Latest (Unstable) Version
 To upgrade to the latest (unstable) version, run
 
@@ -46,11 +39,8 @@ If you are contributing a pull request, it is best to perform a manual installat
 ```sh
 git clone https://github.com/Bilkent-CYBORG/VOPy.git
 cd VOPy
-pip install -e .[dev,docs,examples,test]
+mamba env create --name vopy --file environment.yml  # To setup a proper development environment
+pip install -e .
 ```
 
-<!-- 
-### Run the example experiment as:
-```bash
-python main.py
-``` -->
+For requirements, see [requirements.txt](requirements.txt) or [environment.yml](environment.yml).

environment.yml

@@ -13,10 +13,10 @@ dependencies:
 - jupyter
 - pytest
 - pytest-cov
+- bandit
+- black
 - flake8
 - flake8-print
 - pydocstyle
-- black
-- bandit
 - pip:
     - -r docs/requirements.txt

pyproject.toml

@@ -22,6 +22,12 @@ Homepage = "https://github.com/Bilkent-CYBORG/VOPy"
 Documentation = "https://vopy.readthedocs.io/en/latest/"
 Issues = "https://github.com/Bilkent-CYBORG/VOPy/issues"
 
+[project.optional-dependencies]
+dev = ["black", "flake8", "flake8-print"]
+docs = ["pydocstyle", "sphinx_rtd_theme", "sphinx-notfound-page", "nbsphinx"]
+examples = ["jupyter"]
+test = ["pytest", "pytest-cov", "bandit"]
+
 [build-system]
 requires = ["setuptools>=64", "setuptools-scm>=8"]
 build-backend = "setuptools.build_meta"

requirements.txt

@@ -7,10 +7,10 @@ numpy
 jupyter
 pytest
 pytest-cov
+bandit
+black
 flake8
 flake8-print
 pydocstyle
-black
-bandit
 
 -r docs/requirements.txt