scope-qc
scope-qc is the core SCOPE package: A Chemically-Aware Workflow-Automation Software for Molecules and Molecular Crystals
It provides the main object model and workflow engine used across the SCOPE project.
Optional add-ons such as scope-azo and scope-sco build on top of this core package.
Documentation
- Repository and source code: https://github.com/QTC-IQAC/Scope
- Preprint: https://doi.org/10.26434/chemrxiv.15001415/v2
- Tutorials: https://github.com/QTC-IQAC/Scope_Tutorials
Installation
create and activate conda environment and install pip:
conda create --name scope python=3.12
conda activate scope
conda install pip
# `cell2mol` is an external dependency and must currently be installed separately from its source repository.
pip install "cell2mol @ git+https://github.com/lcmd-epfl/cell2mol.git@55649ba5f444895846a5d049adcb056c01bb0421"
Option 1: from PyPI
pip install scope-qc # Core Modules
Quantum ESPRESSO pseudopotentials:
scope-qcships only theVanderbilt_USPPlibraryEfficiencyandPrecisionare distributed separately through the GitHub releases page: https://github.com/QTC-IQAC/Scope/releases- To use either of them, download the corresponding release asset and extract the
Efficiency/orPrecision/folder intoscope/software/quantum_espresso/PP_Libraries/inside your installedscope-qcpackage
Option 2: from repository
git clone https://github.com/QTC-IQAC/Scope.git
cd Scope
pip install -e core
Option 3: from TestPyPi:
pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ scope-qc
Dependencies
The core package depends on:
numpynetworkx < 3.3scipyrdkitipykernelplotlynbformatjupytermatplotlibplatformdirsPyYAML >= 6.0.1
External prerequisite:
cell2mol, installed separately from https://github.com/lcmd-epfl/cell2mol.git
Python requirement:
- Python 3.12
Command Line Interface
The core package provides the scope command with subcommands for configuring SCOPE environments, creating systems, and running tasks.
For help:
scope -h
Usage
SCOPE is typically used through the command line to:
- configure environments:
scope config - create systems:
scope create_singleandscope create_many - execute workflows:
scope run
For Quantum ESPRESSO jobs, pp_library = vanderbilt is available by default.
If you select efficiency or precision, install that library first from the GitHub releases page above.
System objects are saved in binary files that can then be inspected later in notebooks or other interactive sessions.
License
See the repository-level LICENSE file for licensing information.
Metadata
Release files for scope-qc 0.9.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| scope_qc-0.9.6.tar.gz | 13.4 MB | Without provenance | Details for scope_qc-0.9.6.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| scope_qc-0.9.6-py3-none-any.whl | Python 3 | none | any | Details for scope_qc-0.9.6-py3-none-any.whl |
Total release size: 26.8 MB
Release files / scope_qc-0.9.6.tar.gz
| Download URL | scope_qc-0.9.6.tar.gz |
|---|---|
| Size | 13.4 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
717a57b0e8307b93cd7dedf4f64d91038255c8c55578e0e202d37f6c6352b6a1
|
|
BLAKE2b-256 checksum How to use checksums |
cc439a9d6439cb6bd987175728dd8793588b6c9e45a928ec8f87fcfa9ce0353e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.12
|
Release files / scope_qc-0.9.6-py3-none-any.whl
| Download URL | scope_qc-0.9.6-py3-none-any.whl |
|---|---|
| Size | 13.5 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4a46281ed4e2966e18ad862d6c972ccdd27603a4fe52ba85403f58d310196bcf
|
|
BLAKE2b-256 checksum How to use checksums |
248e3470cbc02f6065d4cf53772eba10dd46d3275d2edb4a6378d8ddb0351974
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.12
|
Security for scope-qc 0.9.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.