Skip to content
Snippets Groups Projects
Commit 29573e36 authored by Alexander Knieps's avatar Alexander Knieps
Browse files

Readme changes

parent a24262d4
No related branches found
No related tags found
No related merge requests found
Pipeline #141096 waiting for manual action
......@@ -4,7 +4,7 @@ This library contains computation mechanisms to support scientific computation.
For more information see the documentation at <https://alexrobomind.github.io/fusionsc>
## Setup (python)
## Regular Setup (pip)
FusionSC can be directly installed from pypi. This will also install a binary redistributable for the fusionsc executable.
```
......@@ -21,7 +21,7 @@ pip install .
## Development setup
### Preparing the build
### Preparing & performing the build
To compile the standalone `fusionsc` executable, you need CMake and a suitable host compiler.
On Linux, openssl might additionaly be required.
......@@ -46,12 +46,20 @@ cmake ../fsc
cmake --build . --target {targetName} --config Release
```
If you want to setup a python development install, you need to also run the util/dev-install.py script (that will create a .pth file in your site-packages dir).
The following targets are available:
The following targets are of particular relevance:
| Function | Target name | Output location |
| ---------------- | ------------------- |----------------------- |
| `fusionsc` tool | fsc-tool | {build}/src/c++/tools |
| python bindings | copy-pybindings | {src}/python/fusionsc |
| tests | tests | {build}/src/c++ |
\ No newline at end of file
| tests | tests | {build}/src/c++ |
| Capnp File ID | capnp-id | Console |
### Setting a development install
In order to have a development install compatible with your python version, you need a .pth file in your site-packages dir pointing to the src/python directory to locate
the fusionsc package. The util/dev-install.py script will set one up for you:
```
python util/dev-install.py
```
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment