Skip to main content

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

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-qc ships only the Vanderbilt_USPP library
  • Efficiency and Precision are 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/ or Precision/ folder into scope/software/quantum_espresso/PP_Libraries/ inside your installed scope-qc package

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:

  • numpy
  • networkx < 3.3
  • scipy
  • rdkit
  • ipykernel
  • plotly
  • nbformat
  • jupyter
  • matplotlib
  • platformdirs
  • PyYAML >= 6.0.1

External prerequisite:

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_single and scope 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 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for scope-qc 1.0.0
File Size Uploaded Provenance Actions
scope_qc-1.0.0.tar.gz 13.4 MB Without provenance Details for scope_qc-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for scope-qc 1.0.0
File Interpreter ABI Platform Actions
scope_qc-1.0.0-py3-none-any.whl Python 3 none any Details for scope_qc-1.0.0-py3-none-any.whl

Total release size: 26.9 MB

Release files / scope_qc-1.0.0.tar.gz

Download URL scope_qc-1.0.0.tar.gz
Size 13.4 MB
Tags Source
SHA-256 checksum
How to use checksums
e6217938a360c72459e5171fd83c4125e2983fdf2a041c9f01cc46003ccf3950
BLAKE2b-256 checksum
How to use checksums
ecd6ded9f26d386c074e40964976d1516f21becaf211625b3d7e0fa4c2dc1681
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-1.0.0-py3-none-any.whl

Download URL scope_qc-1.0.0-py3-none-any.whl
Size 13.5 MB
Tags Python 3
SHA-256 checksum
How to use checksums
cc65b0a247bfccf0dbe6999374e6ef4f96c61bffa261ce37ebb735310a34b02a
BLAKE2b-256 checksum
How to use checksums
add522fa69f2e70b138486a08dea8e21f165cf6696ac614188d6ac7555984084
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 1.0.0

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page