Skip to content

Commit

Permalink
[minor] update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
caitaozhan committed Aug 12, 2024
1 parent 64ba6b0 commit fec349e
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 12 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/Sequence_Icon_Name_Dark.png">
<img src="docs/Sequence_Icon_Name.svg" alt="sequence icon" width="450" class="center">
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/sequence-toolbox/SeQUeNCe/master/docs/Sequence_Icon_Name_Dark.png">
<img src="https://raw.githubusercontent.com/sequence-toolbox/SeQUeNCe/master/docs/Sequence_Icon_Name.svg" alt="sequence icon" width="450" class="center">
</picture>
</p>

Expand All @@ -22,17 +22,18 @@ These modules can be edited by users to define additional functionality and test

## Installing
SeQUeNCe requires an installation of Python 3.8 or later. This can be found at the [Python Website](https://www.python.org/downloads/).
Then, simply download the package, navigate to its directory, and install with

You can install with:
```
pip install sequence
```

Or, download the package, navigate to its directory, and install with
```
git clone https://github.com/sequence-toolbox/SeQUeNCe.git
cd SeQUeNCe
pip install .
```
Or, replace `pip install .` with the included makefile,
```
$ make install
```
This will install the sequence library as well as the package dependencies.

## Citation
Please cite us, thank you!
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
author = 'Xiaoliang Wu, Joaquin Chung, Alexander Kolar, Eugene Wang, Tian Zhong, Rajkumar Kettimuthu, Martin Suchara'

# The full version, including alpha/beta/rc tags
release = '0.6.2'
release = '0.6.2.2'


# -- General configuration ---------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "sequence"
version = "0.6.2"
version = "0.6.2.2"
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"
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

setup(
name="sequence",
version="0.6.2",
version="0.6.2.2",
author="Xiaoliang Wu, Joaquin Chung, Alexander Kolar, Alexander Kiefer, Eugene Wang, Tian Zhong, Rajkumar Kettimuthu, Martin Suchara",
author_email="xwu64@hawk.iit.edu, chungmiranda@anl.gov, akolar@anl.gov, akiefer@iu.edu, eugenewang@yahoo.com, tzh@uchicago.edu, kettimut@mcs.anl.gov, msuchara@anl.gov",
description="Simulator of Quantum Network Communication: SEQUENCE-Python is a prototype version of the official SEQUENCE release.",
Expand Down
2 changes: 1 addition & 1 deletion src/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
__all__ = ['app', 'components', 'entanglement_management', 'kernel', 'network_management', 'qkd', 'resource_management',
'topology', 'utils', 'message', 'protocol', 'gui']

__version__ = '0.6.2'
__version__ = '0.6.2.2'

def __dir__():
return sorted(__all__)

0 comments on commit fec349e

Please # to comment.