|Github_build_badge| |codecov| |Version Status| |Binder|
.. image:: https://raw.githubusercontent.com/BlueBrain/nexus-forge/master/docs/source/assets/bbnforge
Blue Brain Nexus Forge is a domain-agnostic, generic and extensible Python framework enabling non-expert users to create and manage knowledge graphs by making it easy to:
The examples <https://github.com/BlueBrain/nexus-forge/tree/master/examples/notebooks>
__
directory contains many Jupyter Notebooks to get started with
Blue Nexus Forge user features and usage scenarios.
You can run the Getting Started notebooks on Binder by clicking on |Binder|.
For local execution, make sure that the jupyter notebook|lab
is launched
in the same virtual environment where Blue Brain Nexus Forge is installed.
Alternatively, set up a specialized
kernel <https://ipython.readthedocs.io/en/stable/install/kernel_install.html>
__.
In both cases, please start with the notebook named 00 - Initialization. It contains instructions for configuring the Forge with:
After, it is recommended to run the notebooks following their number (01, 02, ...).
It is recommended to use a virtual environment such as venv <https://docs.python.org/3.6/library/venv.html>
or
conda environment <https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html>
.
Stable version
.. code-block:: shell
pip install nexusforge
Upgrade to the latest version
.. code-block:: shell
pip install --upgrade nexusforge
Development version
.. code-block:: shell
pip install git+https://github.com/BlueBrain/nexus-forge
The development of this software was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government's ETH Board of the Swiss Federal Institutes of Technology, and from the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 785907 (Human Brain Project SGA2).
COPYRIGHT © 2019–2022 Blue Brain Project/EPFL
.. |Binder| image:: https://mybinder.org/badge_logo.svg :alt: Binder :target: https://mybinder.org/v2/gh/BlueBrain/nexus-forge/master?filepath=examples%2Fnotebooks%2Fgetting-started
.. |Github_build_badge| image:: https://github.com/BlueBrain/nexus-forge/actions/workflows/test.yml/badge.svg :alt: Build :target: https://github.com/BlueBrain/nexus-forge/actions/workflows/test.yml
.. |Version Status| image:: https://img.shields.io/pypi/v/nexusforge.svg :target: https://pypi.python.org/pypi/nexusforge
.. |codecov| image:: https://codecov.io/gh/BlueBrain/nexus-forge/branch/master/graph/badge.svg?token=YOHG1INCBQ :alt: Coverage :target: https://codecov.io/gh/BlueBrain/nexus-forge