https://github.com/argmaster/scftolus
https://github.com/argmaster/scftolus
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/argmaster/scftolus
- Owner: Argmaster
- License: mit
- Created: 2022-05-08T22:16:15.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-05-15T18:56:51.000Z (almost 4 years ago)
- Last Synced: 2025-01-19T11:30:40.623Z (about 1 year ago)
- Language: C++
- Size: 467 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# scftolus - Luscus extension
Scftolus is a Luscus extension granting support for using scf as
input for generating Luscus scenes.
# Building C++ code
## Working directory
In OS shell, navigate to scftolus repository folder you have cloned from [https://github.com/Argmaster/scftolus](https://github.com/Argmaster/scftolus).
```
git clone https://github.com/Argmaster/scftolus.git
```
## Installing dependencies
**Required**: [Python 3.x](https://www.python.org/downloads/) interpreter, at least version 3.9
All project dependencies are included as git submodules.
> **Warning**:
> Watch out to use appropriate for your platform python interpreter alias.
> On Unix-like platforms python 3.x is commonly aliased as `python3`, on Windows
> you might have installed python loader which can be invoked with `py -3.9`.
To install dependencies use
```
python3 scripts/install_libs.py
```
## Compilation
**Required**: [CMAKE](https://cmake.org/download/) version 3.19 or newer.
Create directory to store build files:
```
mkdir build
```
Generate build system configuration files:
```
cmake ..
```
> **Warning**:
> During development of this code, Ninja build system is used,
> but feel free to use your favorite, however in this example
> we will use ninja.
Build binary files:
```
ninja
```
# Documentation
Online documentation is available at [argmaster.github.io/scftolus/](https://argmaster.github.io/scftolus/).
To build yourself documentation, you need Python 3 interpreter,
at least version 3.9.
> **Warning**:
> Watch out to use appropriate for your platform python interpreter alias.
> On Unix-like platforms python 3.x is commonly aliased as `python3`, on Windows
> you might have installed python loader which can be invoked with `py -3.9`.
> **Tip**:
> Preferred way to install dependencies is to create virtual environment to store them.
> It can be done with:
>
> ```
> python3 -m venv .env
> ```
>
> Then virtual environment have to be enabled via:
>
> - On Unix-like:
>
> ```
> source .env/bin/activate
> ```
>
> - On Windows:
>
> - Powershell:
> ```
> .env\Scripts\activate.bat
> ```
> - cmd.exe:
> ```
> .env\Scripts\Activate.ps1
> ```
>
> [See Python's venv documentation.](https://docs.python.org/3/library/venv.html)
After, run following command to install doc
builder and dependencies:
```
python -m pip install -r requirements-docs.txt
```
To live view docs use
```
mkdocs serve
```
To build docs web page use
```
mkdocs build
```
Static site can be viewed by opening `./site/index.html` in web browser