Skip to content

Commit

Permalink
[minor] fix pyproject.toml, remove setup.py, and update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
caitaozhan committed Aug 19, 2024
1 parent 6d2c8cb commit 9e2fc95
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 38 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,14 @@ SeQUeNCe requires [Python](https://www.python.org/downloads/) 3.8 or later. You
pip install sequence
```

Or, you may install from source:
For [development mode](https://setuptools.pypa.io/en/latest/userguide/development_mode.html) (a.k.a. editable install):
```
git clone https://github.com/sequence-toolbox/SeQUeNCe.git
cd SeQUeNCe
pip install --editable .
pip install --editable . --config-settings editable_mode=strict
```

Note: With `--editable`, any changes you make to the package code are immediately reflected when you import the package and this greatly speeds up the development process. You are free to skip the `--editable` option.
Note: For issues related to editable install, see [link](https://stackoverflow.com/questions/76213501/python-packages-imported-in-editable-mode-cant-be-resolved-by-pylance-in-vscode).

## Citation
Please cite us, thank you!
Expand Down
27 changes: 24 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,32 @@
[project]
name = "sequence"
authors = [
{name = "Xiaoliang Wu", email = "xwu64@hawk.iit.edu"},
{name = "Joaquin Chung", email = "chungmiranda@anl.gov"},
{name = "Alexander Kolar", email = "akolar@anl.gov"},
{name = "Alexander Kiefer", email = "akiefer@iu.edu"},
{name = "Eugene Wang", email = "eugenewang@yahoo.com"},
{name = "Tian Zhong", email = "tzh@uchicago.edu"},
{name = "Rajkumar Kettimuthu", email = "kettimut@mcs.anl.gov"},
{name = "Martin Suchara", email = "msuchara@anl.gov"},
]
version = "0.6.3"
description = "Simulator of QUantum Network Communication (SeQUeNCe) is an open-source tool that allows modeling of quantum networks including photonic network components, control protocols, and applications."
readme = "README.md"
requires-python = ">=3.8"

[tool.setuptools.dynamic]
dependencies = {file = ["requirements.txt"]}

[tool.setuptools]
packages = ['sequence', 'sequence.app', 'sequence.kernel', 'sequence.components',
'sequence.network_management', 'sequence.entanglement_management', 'sequence.qkd',
'sequence.resource_management', 'sequence.topology', 'sequence.utils', 'sequence.gui']

[tool.setuptools.package-data]
sequence = ["gui/user_templates.json", "gui/default_params.json", "gui/starlight.json"]

[project.urls]
homepage = "https://github.com/sequence-toolbox/SeQUeNCe"
documentation = "https://sequence-toolbox.github.io/"
issues = "https://github.com/sequence-toolbox/SeQUeNCe/issues"
Homepage = "https://github.com/sequence-toolbox/SeQUeNCe"
Documentation = "https://sequence-toolbox.github.io/"
Issues = "https://github.com/sequence-toolbox/SeQUeNCe/issues"
1 change: 0 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
numpy>=1.22
scipy<=1.10.1
matplotlib
dash>=1.20.0
dash-core-components
Expand Down
31 changes: 0 additions & 31 deletions setup.py

This file was deleted.

0 comments on commit 9e2fc95

Please # to comment.