diff --git a/README.md b/README.md index 9fe20c4..f294ff6 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Domain specific interpretation of FAIR principles in the context of different ki # About this repository Like any other digital content, UFO models have software and platform dependencies, require version controlling, and can benefit from a unified way of preserving and distributing these resources. This FAIR-principle guided repository has been developed as a comprehensive tool to automate the persistent preservation and dispersion of UFO models and their corresponding metadata, creating a reliable and persistent bridgeway between the developers and users of such models. The primary content of this repository is the `UFOManager` package that consists of two python scripts: `UFOUpload.py` for uploading UFO models and `UFODownlaod.py` for downloading UFO modelss. Both scripts can be used as standalone `Python` scripts or the `UFOManager` package can be incorporated into user-developed custom facilitaor script. -# Dependencies +## Dependencies The functions of the `UFOManager/UFOUpload.py` script i.e. to validate UFO models, generate their metadata, and upload them to zenodo with DOIs are supported with both Python 2 and 3. Meanwhile, `UFOManager/UFODownload.py` is only supported with Python 3. The dependencies to successfully use this package are listed in the files `requirements_Python2.txt` and `requirements_Python3.txt`. The specific instructions to setup the necessary environments and install these dependencies are given in the following section. The following list includes some of the dependencies- @@ -22,7 +22,7 @@ The following list includes some of the dependencies- - [Requests](https://pypi.org/project/requests/) to send HTTP requests for accessing and validating web addresses - [zenodo_get](https://github.com/dvolgyes/zenodo_get) to download files from Zenodo records (only used in Python 3 environment) -# Setup +## Setup (the first time only) This package can be setup by simply downloading it from the git repository and installing the necessary dependencies. To download this package: ```bash $ git clone git@github.com:Neubauer-Group/UFOManager.git @@ -43,7 +43,7 @@ $ pip install -r requirements_Python.txt Here `` is the `Python` version. This will setup the necessary dependencies for the corresponding environment. **Note:** `UFODownload.py` is not supported with `Python 2`, so users willing to search and download models should setup the environment in `Python 3`. -## Before Using the Package +## Before Using the Package (every time) Every time before using the package, one should properly setup the environment and update the `PYTHONPATH` environment variable. ``` $ conda activate ufo