A python package for STROOPWAFEL and GenAIS algorithms
Project description
STROOPWAFEL
Based on https://arxiv.org/abs/1905.00910
A short documentation of stroopwafel implementation can be found here -> https://docs.google.com/document/d/15To_ragEkT13gYitBoCdhq38Z97byrjGtS49Mq8cxG8
Installation
Make sure you have python3 installed in the system, if not it can be downloaded from https://www.python.org/downloads/.
To install this package simply run pip3 install stroopwafel
. [ If you are installing on our slurm cluster helios, then python3 -m pip install --user stroopwafel
should work if you dont have pip3 ]
This package has the following dependencies. They should be automatically installed for you when you install this package.
- numpy
- scipy
To test if its installed, go to python3. On the terminal: python3
.
Inside the python prompt, import stroopwafel
should not throw any errors.
Running
Create an script similar to interface.py in the test directory. Make sure you have the external application executable (such as COMPAS) defined in this script. Provide the other details and functions and run it using python filename.py
.
Note that stroopwafel is independent of the external application and does not have to reside in the same directory.
Additionally you can pass in optional arguments in the command line:
optional arguments:
-h, --help show this help message and exit
--num_systems NUM_SYSTEMS
Total number of systems
--num_cores NUM_CORES
Number of cores to run in parallel
--num_per_core NUM_PER_CORE
Number of systems to generate in one core
--debug DEBUG If debug of COMPAS is to be printed
--mc_only MC_ONLY If run in MC simulation mode only
--run_on_helios RUN_ON_HELIOS
If we are running on helios (or other slurm) nodes
--output_filename OUTPUT_FILENAME
Output filename
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for stroopwafel-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11e324104484e469158d3e93533b14a9ccc16dfbfc9c451a7d780c3c26034602 |
|
MD5 | cc47a7cfe5c38b6b41a16e8399ee5ac3 |
|
BLAKE2b-256 | c73c3faaae5b0a013251d548ad91fe2f12de3269dde4aa76b0a4f77a3489ef4e |
Hashes for stroopwafel-0.0.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | afc84c9350fa1278941b3a93ce7cd6c4040b3fe17e8f1bf172161211fd11c518 |
|
MD5 | f656d688479d2c490f335c49df9bdd6d |
|
BLAKE2b-256 | 58da84aedfcdfb59f1f19c20f4176eb45dda07d8494707bed7a30199e6d0afb9 |