Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/greendelta/openlcajython-manual

The manual to create Jython (Python) scripts in openLCA
https://github.com/greendelta/openlcajython-manual

jython lca openlca python

Last synced: 25 days ago
JSON representation

The manual to create Jython (Python) scripts in openLCA

Host: GitHub
URL: https://github.com/greendelta/openlcajython-manual
Owner: GreenDelta
Created: 2024-11-29T14:39:15.000Z (about 1 month ago)
Default Branch: main
Last Pushed: 2024-12-02T11:44:01.000Z (about 1 month ago)
Last Synced: 2024-12-02T12:31:07.391Z (about 1 month ago)
Topics: jython, lca, openlca, python
Language: Python
Homepage: https://greendelta.github.io/openLCAJython-manual/
Size: 0 Bytes
Stars: 0
Watchers: 4
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# openLCA Jython manual

The manual is created using [mdBook](https://rust-lang.github.io/mdBook/index.html) and can be browsed on its Github page: https://greendelta.github.io/openLCA2-manual/.

In order to publish your changes to the manual, make sure that the `main` branch is up to date and click on _Run workflow_ on the [Deploy mdBook site to Pages](https://github.com/GreenDelta/openLCAJython-manual/actions/workflows/mdbook.yml).

The openLCA Jython manual is compiled from the resources in this repository using [mdBook](https://github.com/rust-lang/mdBook). Thus, you need to have the `mdbook` executable installed (one simple option is to just download the `mdbook` executable from the [mdBook releases page](https://github.com/rust-lang/mdBook/releases) and put it next to the `book.toml` file at the root of this project). Then you can run the build from the command line:

```bash
cd PATH/TO/openLCAJython-manual
mdbook build
```

In order to vizualise your change while working, use the following command:

```bash
cd PATH/TO/openLCAJython-manual
mdbook serve --open
```

See also the [mdBook tutorial](https://rust-lang.github.io/mdBook/index.html) for more options to test the book locally.

## License
This project is in the worldwide public domain, released under the
[CC0 1.0 Universal Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/).

![Public Domain Dedication](https://licensebuttons.net/p/zero/1.0/88x31.png)