1- # Theseus
2- Theseus , a highly-efficient inverse-design algorithm for quantum optical experiments
1+ # PyTheus
2+ PyTheus , a highly-efficient inverse-design algorithm for quantum optical experiments
33
44## Installation
55
@@ -9,24 +9,24 @@ When published it will be possible to install via `pip install`. Untill then, in
99python setup.py install
1010```
1111
12- ## Running Theseus
12+ ## Running PyTheus
1313
1414To list the included examples, type
1515
1616```
17- theseus list
17+ pytheus list
1818```
1919
2020To run one of the included examples, type e.g.
2121
2222```
23- theseus run --example ghz_346
23+ pytheus run --example ghz_346
2424```
2525
2626To run your own input file, type
2727
2828```
29- theseus run PATH_TO_YOUR_INPUT_FILE
29+ pytheus run PATH_TO_YOUR_INPUT_FILE
3030```
3131
3232Output of optimization is saved to a directory called ` output ` . Names of the subdirectorie are specified by the name
@@ -35,17 +35,17 @@ and content of the config file.
3535To plot the graph corresponding to one result saved as a json file, execute
3636
3737```
38- theseus plot PATH_TO_RESULT_FILE
38+ pytheus plot PATH_TO_RESULT_FILE
3939```
4040
4141To analyze a subdirectory corresponding to one run, type
4242
4343```
44- theseus analyze -d outputs/ghz_346/ghz_346
44+ pytheus analyze -d outputs/ghz_346/ghz_346
4545```
4646or just
4747```
48- theseus analyze
48+ pytheus analyze
4949```
5050then an overview of all available folders that can be selected is given.
5151After that one can choose which run (if there exists different run-folders having different
@@ -55,7 +55,7 @@ that can be declared via ```-i```. With ```-pm``` a pdf can be created that show
5555When one wants to set all weights to plus minus one one can choose the option ``` -one ``` .
5656Everthing together:
5757```
58- theseus analyze -d your/directory -one -pm -i 'norm' -i 'ent' -i 'k'
58+ pytheus analyze -d your/directory -one -pm -i 'norm' -i 'ent' -i 'k'
5959```
6060``` norm ``` shows the normalization of the state, ``` ent ``` gives information about entanglement for
6161the different bipartitions and ``` k ``` gives information if there is a k-uniform state and which
@@ -64,9 +64,9 @@ the different bipartitions and ```k``` gives information if there is a k-uniform
6464To get help, add the ` --help ` option to any command. For instance
6565
6666```
67- > theseus run --help
67+ > pytheus run --help
6868
69- Usage: theseus run [OPTIONS] FILENAME
69+ Usage: pytheus run [OPTIONS] FILENAME
7070
7171 Run an input file.
7272
@@ -80,7 +80,7 @@ Options:
8080### Clone repository
8181
8282```
83- git clone https://github.com/artificial-scientist-lab/Theseus .git
83+ git clone https://github.com/artificial-scientist-lab/PyTheus .git
8484```
8585
8686### Create virtual environment
@@ -141,7 +141,7 @@ pip install coverage
141141Then run coverage scan:
142142
143143```
144- coverage run --source=theseus -m unittest discover tests
144+ coverage run --source=pytheus -m unittest discover tests
145145```
146146
147147After that, create the coverage report:
0 commit comments