https://github.com/ssi-dk/bifrost_bridge
https://github.com/ssi-dk/bifrost_bridge
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ssi-dk/bifrost_bridge
- Owner: ssi-dk
- License: mit
- Created: 2024-09-17T13:31:49.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-07T13:36:21.000Z (8 months ago)
- Last Synced: 2025-03-07T14:29:42.853Z (8 months ago)
- Language: Jupyter Notebook
- Size: 503 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bifrost_bridge
This file will become your README and also the index of your
documentation.
## Developer Guide
If you are new to using `nbdev` here are some useful pointers to get you
started.
### Install bifrost_bridge in Development mode
``` sh
# make sure bifrost_bridge package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to bifrost_bridge
$ nbdev_prepare
```
## Usage
### Installation
Install latest from the GitHub
[repository](https://github.com/$GIT_USER_NAME/bifrost_bridge):
``` sh
$ pip install git+https://github.com/$GIT_USER_NAME/bifrost_bridge.git
```
or from [conda](https://anaconda.org/$GIT_USER_NAME/bifrost_bridge)
``` sh
$ conda install -c $GIT_USER_NAME bifrost_bridge
```
or from [pypi](https://pypi.org/project/bifrost_bridge/)
``` sh
$ pip install bifrost_bridge
```
### Documentation
Documentation can be found hosted on this GitHub
[repository](https://github.com/$GIT_USER_NAME/bifrost_bridge)’s
[pages](https://$GIT_USER_NAME.github.io/bifrost_bridge/). Additionally
you can find package manager specific guidelines on
[conda](https://anaconda.org/$GIT_USER_NAME/bifrost_bridge) and
[pypi](https://pypi.org/project/bifrost_bridge/) respectively.
## How to use
Fill me in please! Don’t forget code examples:
``` python
1+1
```
2