fairworkflowsextension
A Jupyterlab extension for searching for Nanopublished computational steps.
Science Score: 54.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 -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.7%) to scientific vocabulary
Repository
A Jupyterlab extension for searching for Nanopublished computational steps.
Basic Info
Statistics
- Stars: 4
- Watchers: 7
- Forks: 1
- Open Issues: 5
- Releases: 1
Metadata Files
README.md
FAIRWorkflowsExtension
A Jupyterlab extension for composing and nanopublishing FAIR workflows, with a mixture of manual and computational tasks.
This extension is composed of a Python package named FAIRWorkflowsExtension
for the server extension and a NPM package named FAIRWorkflowsExtension
for the frontend extension.
Docker setup
It is possible to run the project inside a docker container. Simply run the following command in the project directory:
shell script
docker-compose up
Requirements
- JupyterLab >= 2.0
Install
Note: You will need NodeJS to install the extension.
bash
pip install FAIRWorkflowsExtension
jupyter lab build
(The above should be run from the root of the FAIRWorkflowsExtension repository)
Troubleshoot
If you are seeing the frontend extension but it is not working, check that the server extension is enabled:
bash
jupyter serverextension list
If the server extension is installed and enabled but you are not seeing the frontend, check the frontend is installed:
bash
jupyter labextension list
If it is installed, try:
bash
jupyter lab clean
jupyter lab build
Contributing
Install
The jlpm command is JupyterLab's pinned version of
yarn that is installed with JupyterLab. You may use
yarn or npm in lieu of jlpm below.
```bash
Clone the repo to your local environment
Move to FAIRWorkflowsExtension directory
Install server extension
pip install -e .
Register server extension
jupyter serverextension enable --py FAIRWorkflowsExtension
Install dependencies
jlpm
Build Typescript source
jlpm build
Link your development version of the extension with JupyterLab
jupyter labextension link .
Rebuild Typescript source after making changes
jlpm build
Rebuild JupyterLab after making any changes
jupyter lab build ```
You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.
```bash
Watch the source directory in another terminal tab
jlpm watch
Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch ```
Uninstall
```bash
pip uninstall FAIRWorkflowsExtension
jupyter labextension uninstall FAIRWorkflowsExtension ```
Owner
- Name: FAIR Workflows
- Login: fair-workflows
- Kind: organization
- Website: https://fair-workflows.github.io/
- Repositories: 5
- Profile: https://github.com/fair-workflows
Citation (CITATION.cff)
# YAML 1.2
---
abstract: "A Jupyterlab extension for searching for Nanopublished computational steps."
authors:
-
affiliation: "Netherlands eScience Center"
family-names: Richardson
given-names: Robin
-
affiliation: "Netherlands eScience Center"
family-names: Smits
given-names: Djura
cff-version: "1.0.3"
keywords:
- "nanopublications"
- "fair"
- "notebooks"
- "jupyter"
license: "Apache-2.0"
message: "If you use this software, please cite it using these metadata."
title: "FAIRWorkflowsExtension"
version: "0.1"
GitHub Events
Total
Last Year
Dependencies
- @types/react-dom ^16.9.8 development
- @typescript-eslint/eslint-plugin >=2.25.0 <=2.31.0 development
- @typescript-eslint/parser >=2.25.0 <=2.31.0 development
- eslint ^6.8.0 development
- eslint-config-prettier ^6.10.1 development
- eslint-plugin-prettier ^3.1.2 development
- eslint-plugin-react 7.20.0 development
- mkdirp ^1.0.3 development
- prettier 1.16.4 development
- rimraf ^2.6.1 development
- typescript ~3.7.0 development
- @jupyterlab/application ^3.0.0
- @jupyterlab/coreutils ^5.0.0
- @jupyterlab/notebook ^3.0.0
- @jupyterlab/services ^6.0.0
- react ~17.0.1
- react-dom ~17.0.1
- ts-debounce ^2.0.1
- fairworkflows ==0.2.9
- jupyter-packaging *
- jupyterlab *