Warning
Rsirius is now RSirius! Starting with v3.1+sirius6.3.3, Rsirius is renamed to RSirius to fit the naming convention of PySirius. Please make sure you update your library imports accordingly!
Maintained and prebuild OpenAPI based SIRIUS SDKs for different programming languages such as R, Python and Java. SDKs for other languages can be created using OpenAPI Generator. If you are interested in contributing, please have a look at our contribution guidelines.
For more information about SIRIUS itself, see the SIRIUS repository and SIRIUS documentation.
- For installation via pip from this repository see here
- For installation via conda (conda-forge) see here
The java SDK is part of the SIRIUS project and will be updated with every SIRIUS release. Further instruction can be found here.
The client library versions are combinations of the API version and the SIRIUS version. Example: v3.1+sirius6.3.3 is the client library for SIRIUS 6.3.3 with API version 3.1.
For local testig we suggest following the approaches in PythonTest and RTest (refer also to our contribution guidelines).
Note that our tests always assume the REST service running on port 8080 and that we start SIRIUS manually on this port. This is mainly due to GitHub runners having special layouts of e.g. file hierarchy. Automatic detection of port and PID by the SiriusSDK classes is tested in the conda-forge build process for Windows, macOS and Linux. If you make use of this, you need to remove the hardcoded port from the tests.
Note also that our tests can not be run in parallel, due to the nature of them running on one instance of SIRIUS. A simple example: If the test for job deletion checks if there is one less job after deletion, a parallel test may have already added two more jobs to SIRIUS, making the job deletion test fail even if it worked.