Copyright (C) 2014 Christian T. Jacobs, Alexandros Avdis, Gerard J. Gorman, Matthew D. Piggott. This file is part of PyRDM. PyRDM is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. PyRDM is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with PyRDM. If not, see <http://www.gnu.org/licenses/>.
PyRDM is a Python module for research data management (RDM). It facilitates the automated online publication of scientific software and associated input and output data.
In order to use PyRDM you must build as well as configure the package. Build the package by carrying out the following steps:
- Make a clone of this repository by
git clone https://github.com/pyrdm/pyrdm.git pyrdm
- Install the core dependencies by
cd pyrdm; sudo pip install -r requirements.txt
- Build the package by
sudo make install
- Build the documentation by
make docs. This will produce an HTML version of the documentation in the
docs/builddirectory. Alternatively, you can view the latest version of the documentation here.
The next step involves configuring PyRDM in order for it to access and upload files to Figshare, Zenodo or DSpace. Please see the PyRDM documentation for a graphical guide on how to do this.
PyRDM depends on:
- Sphinx - to build the documentation.
libspud - this package is not necessary if you do not wish to run the PyRDM-based publication tool
fluidity-publishspecifically designed for the Fluidity CFD code.
When citing PyRDM, please use the following citation:
- C. T. Jacobs, A. Avdis, G. J. Gorman, M. D. Piggott (2014). PyRDM: A Python-based library for automating the management and online publication of scientific software and data. Journal of Open Research Software, 2(1):e28, DOI: https://doi.org/10.5334/jors.bj
If you have any questions or comments about PyRDM, please send them via email to C.T.Jacobs@soton.ac.uk.