Skip to content

Commit dd0bda4

Browse files
committed
docs: Simplify README
Signed-off-by: Sietze van Buuren <[email protected]>
1 parent 9f23968 commit dd0bda4

File tree

1 file changed

+2
-71
lines changed

1 file changed

+2
-71
lines changed

README.md

Lines changed: 2 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -36,80 +36,11 @@ Refer to the [documentation](https://swvanbuuren.github.io/cubinterpp/) for:
3636

3737
- [Requirements](https://swvanbuuren.github.io/cubinterpp/requirements/)
3838
- [Usage instructions](https://swvanbuuren.github.io/cubinterpp/usage/)
39+
- [Single header file](https://swvanbuuren.github.io/cubinterpp/usage#single-header-library)
40+
- [Build from source](https://swvanbuuren.github.io/cubinterpp/usage#build-from-source)
3941
- [Mathematical background](https://swvanbuuren.github.io/cubinterpp/theory/)
4042
- [Code reference](https://swvanbuuren.github.io/cubinterpp/reference/)
4143

42-
### Building
43-
44-
To build the header library for usage in Python, it's recommended to use
45-
[cmake](https://cmake.org/). An appropriate cmake configuration is provided in
46-
the main [`CMakeLists.txt`](CMakeLists.txt). Prior to compilation, the required
47-
external libraries are downloaded automatically using the cmake FetchContent
48-
module. Prior to building, make sure `cmake` is installed and configured with a
49-
C++ compiler like e.g. [gcc](https://gcc.gnu.org/). In order to create the
50-
python module, the development python library is also required.
51-
52-
In order to do so on a Debian based system, install `cmake`, `gcc`, `g++` and
53-
`python3.11-dev` (change the python version depending on your configuration):
54-
55-
```bash
56-
sudo apt install cmake gcc g++ python3.11-dev
57-
```
58-
59-
Set the appropriate environment variables (it's recommended to add these lines
60-
to e.g. your `.bashrc`):
61-
62-
```bash
63-
export CC=/usr/bin/gcc
64-
export CXX=/usr/bin/g++
65-
```
66-
67-
Then create and move into the build directory, configure cmake and build using:
68-
69-
```bash
70-
mkdir build
71-
cd build
72-
cmake ..
73-
make
74-
```
75-
76-
This should build `cubinterpp` and automatically copy the library file
77-
`cubic_spline.*.so` into the `cubinterpp` directory.
78-
79-
### Testing
80-
81-
This library comes with severals [tests](tests). To run all tests, first build
82-
and then run (while remaining in the `build` directory):
83-
84-
```bash
85-
ctest -V
86-
```
87-
88-
### Interpolating and plotting the results
89-
90-
A [python program](cubinterpp/main.py) is provided to compare the three
91-
interpolation types. Data preparation and visualization is done in python with
92-
[mlpyqtgraph](https://github.com/swvanbuuren/mlpyqtgraph).
93-
94-
In order to run the python program, it's recommended to [install
95-
uv](https://docs.astral.sh/uv/getting-started/installation/#standalone-installer)
96-
and issue:
97-
98-
```bash
99-
uv run cubinterpp
100-
```
101-
102-
This should install all required python dependencies automatically and run the
103-
python program that does the interpolation and plotting, resulting in the
104-
comparison plot shown at the top of this document.
105-
106-
### Further reading
107-
108-
Check out the [usage
109-
instructions](https://swvanbuuren.github.io/cubinterpp/usage/) in the
110-
[documentation](https://swvanbuuren.github.io/cubinterpp/) for more details and
111-
examples.
112-
11344
## License
11445

11546
An MIT style license applies for cubinterpp, see the [LICENSE](LICENSE) file for

0 commit comments

Comments
 (0)