Skip to content

Latest commit

 

History

History
105 lines (70 loc) · 3.08 KB

README.md

File metadata and controls

105 lines (70 loc) · 3.08 KB

reasoner-tools

renci.org

Tools Available:

Onto API

Onto is a facility which aggregates lookup services that provide generic facts about ontologies. It leverages the Uberongraph RDB (a SPARQL-queried Uberongraph available at https://stars-app.renci.org/uberongraph/#query) for data.

To edit/execute/test Onto API locally:

- TO EDIT:
$git clone [email protected]:NCATS-Translator/reasoner-tools

- make a virtual env and activate it, recommended as follows:
$python3 -m venv YOUR_ENV_NAME
$source YOUR_ENV_NAME/bin/activate

$cd reasoner-tools

Make functionality changes in greent/services/ontology.py
Make front-end changes in greent/api/onto_gunicorn.py
The above two files should be considered in tandem.

Add unit test cases to greent/test/test_ontology.py

- TO RUN:
$cd reasoner-tools
$pip install -r greent/requirements.txt

$gunicorn onto_gunicorn:app --workers 1 --pythonpath=$PWD/greent/api
Navigate in your browser to http://127.0.0.1:8000/apidocs.


- TO TEST:
$cd reasoner-tools

Note: If you're running a local server, edit the onto URL in greent/greent.conf to point to 127.0.0.1:8000.
$export greent_conf=greent/greent.conf
$export PYTHONPATH=$PWD:$PWD/greent/api

- To run all unit tests:
pytest greent/test/test_ontology.py
    
- Remove warnings and get more information as tests run:
pytest -p no:warnings -vv greent/test/test_ontology.py
    
- Run a single unit test:
pytest greent/test/test_ontology.py -k <test_name>
pytest greent/test/test_ontology.py -k test_label

- Do code coverage for onto:
pytest --cov=greent --cov-report term --cov-config=greent/test/.onto_coveragerc greent/test/test_ontology.py

BioNames API

BioNames is a generic facility which aggregates bio-ontology lookup services. It retrieve names from IDs or IDs based on Natural Language names.

To edit/execute/test BioNames API locally:

- TO EDIT:
$git clone [email protected]:NCATS-Translator/reasoner-tools

- make a virtual env and activate it, recommended as follows:
$python3 -m venv YOUR_ENV_NAME
$source YOUR_ENV_NAME/bin/activate

$cd reasoner-tools

Make functionality changes in greent/services/bionames.py
Make front-end changes in builder/api/naming.py
The above two files should be considered in tandem.

Add unit test cases to greent/test/test_bionames.py


- TO RUN:
$pip install -r greent/requirements.txt

$PYTHONPATH=$PWD python3 builder/api/naming.py
- Navigate in your browser to localhost:5000/apidocs.


- TO TEST:
$cd reasoner-tools

Note:  If you're running a local server, edit the bionames URL in greent/greent.conf to point to localhost:5000
$export greent_conf=greent/greent.conf
$export PYTHONPATH=$PWD:$PWD/builder/api
    
- To run all unit tests:
pytest greent/test/test_bionames.py
    
- Remove warnings and get more information as tests run:
pytest -p no:warnings -vv greent/test/test_bionames.py
    
- Run a single unit test:
pytest greent/test/test_bionames.py -k <test_name>
pytest greent/test/test_bionames.py -k test_lookup_router

- Do code coverage for bionames:
pytest --cov=greent --cov-report term --cov-config=greent/test/.bionames_coveragerc greent/test/test_bionames.py