Skip to content

Commit

Permalink
docs (continued)
Browse files Browse the repository at this point in the history
  • Loading branch information
nickzoic committed Oct 27, 2023
1 parent 1437e5a commit 1eb61e4
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 20 deletions.
4 changes: 4 additions & 0 deletions docs/running-countess/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Running CountESS

## GUI

To run the CountESS GUI, use `countess_gui`.

A CountESS pipeline consists of a bunch of components called 'nodes',
Expand All @@ -23,6 +25,8 @@ the link.
Only the first few thousand rows of input files are read at configuration time.
To perform a complete run using the entire input file, click 'Run'.

## CLI

Plugin configurations can be saved and loaded in .INI file format.
CountESS can also be run in headless mode with `countess_cmd your_config.ini`.

21 changes: 1 addition & 20 deletions docs/writing-plugins/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ be distributed over many CPUs.

Some plugins may operate on a single input value, others on an entire row.
Some plugins may generate a single output value, others several.
For convenient, several subclasses are provided:
For convenience, several subclasses are provided:

* PandasTransformSingleToSinglePlugin

Expand Down Expand Up @@ -125,25 +125,6 @@ class declaration using subclasses of `countess.core.parameters.BaseParameter`.
Configuration values are provided by a [single configuration file](../config-file-format/)
which is read and written by the CountESS GUI and read by the CountESS CLI.

## Subclassing `BasePlugin`

To make life easier, there are several subclasses of `BasePlugin`
under `countess.core.plugins` ... each of these provides common
features used in different types of plugins.

### PandasSimplePlugin

### PandasTransform**X**To**Y**Plugin

There are several classes of the form `PandasTransform`**X**`To`**Y**`Plugin`.

The most obviously useful ones are `PandasTransformSingleToSinglePlugin`,
which translates a single value into another single value, and
`PandasTransformDictToDictPlugin`, which translates an entire table row.

To use these classes, subclass the appropriate one for your plugin and
override `process_value`, `process_row` or `process_dict` as appropriate.

## Example Plugins

Under [example-plugins](../example-plugins/) are files showing the
Expand Down

0 comments on commit 1eb61e4

Please sign in to comment.