Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spine-tools/spineinterface.jl
A package to interact with Spine databases from a Julia session
https://github.com/spine-tools/spineinterface.jl
Last synced: about 1 month ago
JSON representation
A package to interact with Spine databases from a Julia session
- Host: GitHub
- URL: https://github.com/spine-tools/spineinterface.jl
- Owner: spine-tools
- License: lgpl-3.0
- Created: 2019-03-26T10:16:33.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-31T09:19:02.000Z (7 months ago)
- Last Synced: 2024-06-11T19:03:14.723Z (7 months ago)
- Language: Julia
- Homepage: http://www.spine-model.org
- Size: 1.21 MB
- Stars: 8
- Watchers: 7
- Forks: 4
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: COPYING
Awesome Lists containing this project
README
# SpineInterface.jl
[](https://spine-tools.github.io/SpineInterface.jl/latest/index.html)
[](https://codecov.io/gh/Spine-tools/SpineInterface.jl)
A package to interact with Spine databases from a Julia session.
## Compatibility
This package requires Julia 1.8 or later.
## Installation
You can install SpineInterface from the SpineJuliaRegistry as follows:
```julia
using Pkg
pkg"registry add https://github.com/Spine-tools/SpineJuliaRegistry"
pkg"add SpineInterface"
```
However, for keeping up with the latest developments, it is highly recommended to install directly from the source.
This can be done by downloading the repository on your computer, and then installing the module locally with
```julia
using Pkg
Pkg.develop("")
```
where `` is the path to the root folder of the SpineInterface repository on your computer *(the one containing the `Project.toml` file)*.
SpineInterface has been primarily designed to work through [Spine Toolbox](https://github.com/spine-tools/Spine-Toolbox),
and shouldn't require specific setup when being called from Spine Toolbox workflows.
When running SpineInterface outside Spine Toolbox *(e.g. from a Julia script directly)*, however,
SpineInterface relies on the [Spine Database API](https://github.com/spine-tools/Spine-Database-API)
Python package, which is accessed using the [PyCall.jl](https://github.com/JuliaPy/PyCall.jl) module.
Thus, one needs to configure PyCall.jl to use a Python executable with Spine Database API installed,
which can be done according to the PyCall readme.
If you're using Conda environments for Python, the `.configure_pycall_in_conda.jl` script can be used to
automatically configure PyCall to use the Python executable of that Conda environment.
## Trouble shooting
When the `Julia` runs under an active `Conda` environment, updating the `Julia` environment raises an error.
Make sure to deactivate the `Conda` environment before updating the `Julia` environment.
The error is subject to be fixed.
## Upgrading
SpineInterface may be updated from time to time. To get the most recent version, just:
1. Start the Julia REPL (can be done also in the Julia console of Spine Toolbox).
2. Copy/paste the following text into the julia prompt:
```julia
using Pkg
Pkg.update("SpineInterface")
```
NOTE. It seems that Pkg.update does not always guarantee the latest version. `Pkg.rm("SpineInterface")` followed by `Pkg.add("SpineInterface")` may help.
If you have installed SpineInterface from source locally on your machine, you can update it simply by pulling the latest `master` from the repository.
## Usage
Essentially, SpineInterface works just like any Julia module
```julia
using SpineInterface
url = "sqlite:///quick_start.sqlite"
commitmessage = "initial commit"
import_data(url,commitmessage;
object_classes=["colors", "shapes"],
objects = [
["colors", "red"],
["colors", "blue"],
["shapes", "square"],
["shapes", "circle"]
]
)
using_spinedb(url)
colors()#returns all colors
shapes("square")#returns the square
```
with `import_data` and `using_spinedb` being the key functions for interfacing a Spine Datastore.
`import_data` is used to create a new Spine Datastore or write data to an existing Spine Datastore.
`using_spinedb` creates the convenience functions to access the data in the Spine Datastore.
## Reporting Issues and Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md)
## License
SpineInterface is licensed under GNU Lesser General Public License version 3.0 or later.
### Acknowledgements
This work has been partially supported by EU project Mopo (2023-2026), which has received funding from European Climate, Infrastructure and Environment Executive Agency under the European Union’s HORIZON Research and Innovation Actions under grant agreement N°101095998.
This work has been partially supported by EU project Spine (2017-2021), which has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 774629.