Data

Tools

Indexes

Applications

Experiments

Open Source Science

acsys-python

Python module to access the Fermilab Control System

https://github.com/fermi-ad/acsys-python

Science Score: 52.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ✓
    Institutional organization owner
    Organization fermi-ad has institutional domain (ad.fnal.gov)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.5%) to scientific vocabulary

Keywords

application
Last synced: 6 months ago · JSON representation ·

Repository

Python module to access the Fermilab Control System

Basic Info
  • Host: GitHub
  • Owner: fermi-ad
  • License: other
  • Language: Python
  • Default Branch: v0.x
  • Homepage:
  • Size: 370 KB
Statistics
  • Stars: 9
  • Watchers: 4
  • Forks: 2
  • Open Issues: 21
  • Releases: 0
Topics
application
Created about 5 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.md

ACSys Python DPM Client

acsys is the interface to Fermilab data acquisition and control.

EXAMPLES: If you are looking for examples to dive in on, please see the wiki examples.

Installing

acsys is available via a Fermi hosted pip repository.

bash python3 -m pip install acsys --extra-index-url https://www-bd.fnal.gov/pip3

The command above will get you up and going quickly. See usage examples in the wiki.

If you need to perform settings, you will need the optional authentication library, gssapi.

bash python3 -m pip install "acsys[settings]" --extra-index-url https://www-bd.fnal.gov/pip3

Note: This package only authenticates you as a user. There are other requirements to be able to set devices. Please make a request to the Controls Department for setting access.

Building and Distributing

All dependencies are managed via pyproject.toml.

Start by creating and activating a virtual environment.

bash python3 -m venv venv source ./venv/bin/activate

To build the project, ensure you have your development dependencies installed.

bash pip install -e ".[dev]"

This command installs your project in an editable mode along with all its development dependencies, like build and wheel.

Make sure pyproject.toml has the correct version number.

bash make

will create a source distribution at ./dist.

This should only be used for development.

bash make all

The above will generate "built distributions" as well as the source distributions from make.

Releasing a New Version

Set the new version

Ensure all your changes are committed to Git. Create a new Git tag for the version you are releasing. The tag name should follow the semver format vX.Y.Z.

bash git tag vVID

Deploy the distributions

Run the deploy make target to build the package and push it to the pip server. This process will automatically use the new version from your Git tag.

bash make deploy

Push the tags

Finally, push the new tag to the remote repository. This makes the new version official in your project's history.

bash git push --tags

Development

To get started with development, simply follow the "Building and Distributing" section. The pip install -e ".[dev]" command will set up your virtual environment so that any changes you make to the source code will be immediately reflected in your venv.

Owner

  • Name: Fermilab Accelerator Directorate
  • Login: fermi-ad
  • Kind: organization
  • Location: United States of America

Fermilab Accelerator Systems

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Harrison"
  given-names: "Beau"
  orcid: "https://orcid.org/0000-0001-9555-2243"
- family-names: "Neswold"
  given-names: "Richard"
  orcid: "https://orcid.org/0009-0000-1009-5910"
title: "ACSys Python Client Library"
version: 0.12
date-released: 2022-03-25
url: "https://github.com/fermi-controls/acsys-python"

GitHub Events

Total
  • Issues event: 5
  • Watch event: 2
  • Member event: 1
  • Issue comment event: 2
  • Push event: 9
  • Pull request review event: 3
  • Pull request event: 4
  • Create event: 4
Last Year
  • Issues event: 5
  • Watch event: 2
  • Member event: 1
  • Issue comment event: 2
  • Push event: 9
  • Pull request review event: 3
  • Pull request event: 4
  • Create event: 4

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 5
  • Total pull requests: 3
  • Average time to close issues: over 3 years
  • Average time to close pull requests: 24 minutes
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 1.4
  • Average comments per pull request: 0.33
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 3
  • Average time to close issues: N/A
  • Average time to close pull requests: 24 minutes
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.33
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • beauremus (6)
  • gopikaops (3)
  • rneswold (1)
Pull Request Authors
  • rneswold (3)
  • beauremus (3)
Top Labels
Issue Labels
bug (7) good first issue (1) future (1)
Pull Request Labels
bug (1)

Dependencies

requirements.txt pypi
  • gssapi *
  • importlib-metadata *
  • nest_asyncio *
setup.py pypi
  • gssapi *
  • importlib-metadata *
  • nest_asyncio *
.github/workflows/python-package.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
settings_requirements.txt pypi
  • gssapi *