Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXOPTS ?= -v
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build
Expand Down
37 changes: 10 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,35 +5,18 @@
This repository has the source code for the IDAES+ documentation,
which covers all projects that use the [IDAES](https://idaes.org) platform.

## Updating pages from Airtable
## Updating tabular input data

### Explanation
The data that builds tables of content for several pages is in CSV files under data/.
Filenames in that directory should correspond to Markdown files they belong to.
This data is post-processed into YAML that is then used by the documentation pages
to create content.

These pages have tables created from data in the IDAES+ project on Airtable.
[Airtable](https://airtable.com) is an online database that can be jointly
edited like a shared spreadsheet.
To update the CSV, just use your favorite spreadsheet program or
a text editor. Make sure to save as plain CSV again, and commit your
changes to the repository.

The current method of connecting this data to the documentation pages is to
fetch that data and format it as a YAML file. The downside to this procedure, as
opposed to fetching the data directly from within the documentation pages via
JavaScript, is an extra step to propagate changes from Airtable to the
documentation. The upside is that changes in the documentation are deployed
intentionally and not accidentally when the Airtable data is changed. This
should result in less surprises and more chances to check for errors.

### How-to

To update the file, run the `update_data.py` script and write the output to `data.yaml`.
When you're done, you need to update the YAML input files from the CSV,
run the `update_data.py` script and write the output to `data.yaml`.

For example: `python update_data.py data.yaml`

In order to connect to Airtable and retrieve the data, you will need to provide
the correct API key for IDAES+. This is a secret and not in this repository.
Once you have obtained this key either provide it directly on the command-line
or set it in the environment variable `IDAES_AIRTABLE_APIKEY`.

You can cache the data retrieved from Airtable with the `--cache` option, e.g.:
`python update_data.py data.yaml --cache cache.json`. In this mode, no new data
is fetched, but the raw data is reformatted for the web pages. This is useful
when working on the script itself. Note also that if the cache file exists the
script does not attempt to connect to Airtable, so the API key is not needed.
34 changes: 34 additions & 0 deletions contact.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: IDAES+ Contact and Support
---
# IDAES+ Contact and Support

The IDAES+ projects are a coalition of government, academic, and industry
partners building a community-based open-source platform for advanced process
simulation.

## GitHub Discussions

**Ask technical questions and engage with the community:**

- IDAES: <https://github.com/IDAES/idaes-pse/discussions>
- PrOMMiS: <https://github.com/orgs/prommis/discussions>
- WaterTAP: <https://github.com/orgs/watertap-org/discussions>
- PARETO: <https://github.com/orgs/project-pareto/discussions>

## Email Support

**For private inquiries:**

- IDAES: <idaes-support@lbl.gov>
- PrOMMiS: <prommis-support@lbl.gov>
- WaterTAP: <watertap-support@lbl.gov>
- CCSI: <ccsi-support@acceleratecarboncapture.org>
- PARETO: <pareto-support@lbl.gov>

## Join Our Community

Interested in staying updated with releases, progress, and announcements?

Go to this [registration page](https://idaes.org/register/) to join our user
mailing lists.
Loading