Data

Tools

Indexes

Applications

Experiments

Open Source Science

python-icat

Python interface to ICAT and IDS

https://github.com/icatproject/python-icat

Science Score: 64.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
    Links to: zenodo.org
  • ✓
    Committers with academic emails
    2 of 4 committers (50.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.0%) to scientific vocabulary

Keywords

metadata metadata-catalogue python scientific-data
Last synced: 6 months ago · JSON representation ·

Repository

Python interface to ICAT and IDS

Basic Info
Statistics
  • Stars: 13
  • Watchers: 7
  • Forks: 6
  • Open Issues: 7
  • Releases: 16
Topics
metadata metadata-catalogue python scientific-data
Created over 10 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog License Citation

README.rst 

|doi| |rtd| |pypi|

.. |doi| image:: https://zenodo.org/badge/37250056.svg
   :target: https://zenodo.org/badge/latestdoi/37250056

.. |rtd| image:: https://img.shields.io/readthedocs/python-icat/latest
   :target: https://python-icat.readthedocs.io/en/latest/
   :alt: Documentation build status

.. |pypi| image:: https://img.shields.io/pypi/v/python-icat
   :target: https://pypi.org/project/python-icat/
   :alt: PyPI version

python-icat – Python interface to ICAT and IDS
==============================================

This package provides a collection of modules for writing Python
programs that access an `ICAT`_ service using the SOAP interface.  It
is based on Suds and extends it with ICAT specific features.

Download
--------

The latest release version can be found at the
`release page on GitHub`__.

.. __: `GitHub release`_


Documentation
-------------

See the `online documentation`__.

Example scripts can be found in doc/examples.  This is mostly an
unsorted collection of test scripts that I initially wrote for myself
to try things out.

Almost all scripts use example_data.yaml as input for test data.  Of
course for real production, the input will come from different
sources, out of some workflow from the site.  But this would be
dynamic and site specific and thus not suitable, neither for testing
nor for the inclusion into example scripts.  So its easier to have
just one blob of dummy input data in one single file.  That is also
the reason why the example scripts require PyYAML.

.. __: `Read the Docs site`_


Copyright and License
---------------------

Copyright 2013–2024
Helmholtz-Zentrum Berlin für Materialien und Energie GmbH

Licensed under the `Apache License`_, Version 2.0 (the "License"); you
may not use this file except in compliance with the License.

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.  See the License for the specific language governing
permissions and limitations under the License.


.. _ICAT: https://icatproject.org/
.. _GitHub release: https://github.com/icatproject/python-icat/releases/latest
.. _Read the Docs site: https://python-icat.readthedocs.io/
.. _Apache License: https://www.apache.org/licenses/LICENSE-2.0

Owner

  • Name: icatproject
  • Login: icatproject
  • Kind: organization

ICAT is a metadata catalogue for large-scale science facilities

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: python-icat – Python interface to ICAT and IDS
type: software
authors:
  - given-names: Rolf
    family-names: Krahl
    email: rolf.krahl@helmholtz-berlin.de
    affiliation: >-
      Helmholtz-Zentrum Berlin für Materialien und
      Energie
    orcid: 'https://orcid.org/0000-0002-1266-3819'
  - name: The ICAT project
    website: 'https://icatproject.org/'
repository-code: 'https://github.com/icatproject/python-icat'
repository-artifact: 'https://github.com/icatproject/python-icat/releases/latest'
abstract: >-
  The ICAT server is a metadata catalogue to support Large
  Facility experimental data, linking all aspects of the
  research chain from proposal through to publication. It
  provides SOAP and RESTful web service interfaces to an
  underlying database.

  python-icat is a Python package that provides a collection
  of modules for writing programs that access an ICAT
  service using the SOAP interface. It is based on Suds and
  extends it with ICAT specific features.
keywords:
  - python
  - metadata
  - scientific-data
  - metadata-catalogue
license: Apache-2.0

GitHub Events

Total
  • Create event: 4
  • Issues event: 1
  • Release event: 2
  • Watch event: 1
  • Delete event: 2
  • Push event: 16
  • Pull request event: 4
Last Year
  • Create event: 4
  • Issues event: 1
  • Release event: 2
  • Watch event: 1
  • Delete event: 2
  • Push event: 16
  • Pull request event: 4

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 1,262
  • Total Committers: 4
  • Avg Commits per committer: 315.5
  • Development Distribution Score (DDS): 0.024
Top Committers
Name Email Commits
Rolf Krahl r****l@h****e 1,232
Rolf Krahl r****f@r****e 12
Emil Junker e****r@o****m 12
Matthew Richards m****s@s****k 6
Committer Domains (Top 20 + Academic)
stfc.ac.uk: 1 rotkraut.de: 1 helmholtz-berlin.de: 1

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 85
  • Total pull requests: 68
  • Average time to close issues: 4 months
  • Average time to close pull requests: 10 days
  • Total issue authors: 10
  • Total pull request authors: 2
  • Average comments per issue: 0.96
  • Average comments per pull request: 0.76
  • Merged pull requests: 64
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 10
  • Average time to close issues: 9 days
  • Average time to close pull requests: 5 days
  • Issue authors: 2
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.2
  • Merged pull requests: 8
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • RKrahl (70)
  • MRichards99 (5)
  • gc-code (1)
  • louise-davies (1)
  • dfq16044 (1)
  • antolinos (1)
  • evidencebp (1)
  • stuartpullinger (1)
  • solcaj (1)
  • salk31 (1)
Pull Request Authors
  • RKrahl (80)
  • MRichards99 (3)
Top Labels
Issue Labels
enhancement (39) bug (21) compatibility (9) documentation (4) wontfix (4) invalid (3) test suite (3) Release (2) toolchain (1) internal (1)
Pull Request Labels
enhancement (40) documentation (17) bug (11) compatibility (7) test suite (7) toolchain (6) internal (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 1,120 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 3
  • Total versions: 16
  • Total maintainers: 1
pypi.org: python-icat

Python interface to ICAT and IDS

  • Versions: 16
  • Dependent Packages: 0
  • Dependent Repositories: 3
  • Downloads: 1,120 Last month
Rankings
Downloads: 8.9%
Dependent repos count: 8.9%
Dependent packages count: 10.1%
Average: 11.8%
Forks count: 13.3%
Stargazers count: 17.7%
Maintainers (1)
Rotkraut
Last synced: 7 months ago