Data

Tools

Indexes

Applications

Experiments

Open Source Science

resosuma

A Python package for mapping the research software sustainability space

https://github.com/research-software/resosuma

Science Score: 44.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
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.6%) to scientific vocabulary
Last synced: 8 months ago · JSON representation ·

Repository

A Python package for mapping the research software sustainability space

Basic Info
  • Host: GitHub
  • Owner: research-software
  • License: apache-2.0
  • Language: Python
  • Default Branch: master
  • Size: 17.6 KB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 2
Created almost 8 years ago · Last pushed over 7 years ago
Metadata Files
Readme Changelog License Citation

README.rst 

.. image:: https://travis-ci.org/research-software/resosuma.svg?branch=master
   :target: https://travis-ci.org/research-software/resosuma/builds
.. image:: https://img.shields.io/github/license/research-software/resosuma.svg
   :target: ../master/LICENSE


Resosuma
========

`resosuma` (short for **re**\ search **so**\ ftware **su**\ stainability **ma**\ p) is a package for
Python 3 which provides a data model (directed graph) for activities in the
research software sustainability space ("the space").

In the graph, *actors* (i.e., entities that act within the space) and *actees*
(i.e., entities which are acted on) are represented as nodes, and *actions*
are represented as edges.

Currently, a `resosuma` model can be instantiated by reading the data from
3-column CSV, where the first column is the *actor* of an *action*, the
second column is the *action* itself, and the third column is the *actee* of
the *action*.

Requirements
============

`resosuma` requires Python 3 (tested against 3.4, 3.5, 3.6).


Installation
============

Install resosuma with pip::

    pip install resosuma


Usage
=====

To instantiate a `resosuma` model of type `ActivityGraph`, you can call::

    from resosuma.graph.activitygraph import ActivityGraph
    
    graph = ActivityGraph()
    graph.read_csv(csvpath)


Once the model is instantiated, you can inspect it via::

    graph.get_activities()
    graph.get_nodes()

Scripts
-------

`visualize.py` visualizes the model via graphviz.::

    usage: visualize.py [-h] csv_file output {svg,pdf,png}
    
    positional arguments:
      csv_file       The path of the input CSV file
      output         The path of the output file
      {svg,pdf,png}  The output format
    
    optional arguments:
      -h, --help     show the help message and exit

How to cite
===========

The metadata necessary for citing `resosuma` can be found in the `CITATION.cff` file.


Contribute
==========

This project welcomes contributions. 
Please suggest features and report bugs via issues.

Owner

  • Name: research-software
  • Login: research-software
  • Kind: organization

Citation (CITATION.cff) 

cff-version: 1.0.3
message: If you use resosuma, please cite it as below.
authors:
  - family-names: Druskat
    given-names: Stephan
    orcid: https://orcid.org/0000-0003-4925-7248
title: resosuma
version: 0.2.0
doi: 10.5281/zenodo.1304254
date-released: 2018-07-03

GitHub Events

Total
Last Year

Committers

Last synced: about 3 years ago

All Time
  • Total Commits: 3
  • Total Committers: 2
  • Avg Commits per committer: 1.5
  • Development Distribution Score (DDS): 0.333
Top Committers
Name Email Commits
Stephan Druskat m****l@s****t 2
Stephan Druskat s****t@u****m 1
Committer Domains (Top 20 + Academic)
sdruskat.net: 1

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

requirements.txt pypi
  • flake8 ==3.5.0
  • graphviz ==0.8.3
  • pytest ==3.6.2
  • tox ==3.0.0
setup.py pypi
  • graphviz ==0.8.3