Relocate wiki from trac
This commit is contained in:
6
wiki/help/cmdline.md
Normal file
6
wiki/help/cmdline.md
Normal file
@@ -0,0 +1,6 @@
|
||||
Fluents takes the following command line options:
|
||||
| | |
|
||||
|----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `-h` or `--help` | Displays help index, which is probably more updated than what is documented on the web. |
|
||||
| `-l` or `--workflow-list` | Lists the available workflows. Available workflows must be in the workflows package and must load on your system. |
|
||||
| `-w workflow` or `--workflow=workflow` | Creates a new project using the given workflow. Use -l to get a list of workflows. The workflow parameter is the identifier of the workflow. |
|
||||
25
wiki/help/config.md
Normal file
25
wiki/help/config.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# Configuration
|
||||
|
||||
Laydi reads configuration from two types of configuration files. The main configuration is read from `/etc/laydirc/` and `$HOME/.laydi`. The possible variables in this configuration are described in the section Laydi configuration below.
|
||||
|
||||
The other file is the settings file for the matplotlib plotting package that is used in Laydi. This package has a lot of settings on its own, and instead of incorporating it into the general laydi configuration file it is distributed as a separate `matplotlibrc` file with options suitable for use in Laydi.
|
||||
|
||||
## Laydi configuration
|
||||
|
||||
### Directories
|
||||
|
||||
#### datadir
|
||||
|
||||
datadir is a directory for datasets. There are helper functions that makes it easy for a workflow to load data from this directory.
|
||||
|
||||
#### cachedir
|
||||
|
||||
cachedir is a directory where laydi can write cached data at will.
|
||||
|
||||
#### workflowdir
|
||||
|
||||
workflowdir is a path of directories where Laydi should look for workflows. When Laydi is started the `-w ''workflow''` option, these are the directories that will be searched for workflows. Note that *all* directories in `workflowdir` are added to the python path. If you add your own workflow directory, make sure that no files in the directory interfere with Laydi modules or standard Python modules.
|
||||
|
||||
## Matplotlib configuration
|
||||
|
||||
Matplotlib is configured with a matplotlib configuration file included with laydi. Documentation for the various options are included as comments in the file itself.
|
||||
19
wiki/help/format/fcsv.md
Normal file
19
wiki/help/format/fcsv.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# Fluents Comma Separated Values file format description
|
||||
|
||||
This is the documentation of the textual (and primary) Fluents data file format. The other way to store a dataset is as a pickled Dataset object. The main differences between these methods are:
|
||||
|
||||
- Text based file formats are easier to read, easier to browse throgh, running commands on etc.
|
||||
- Text based files are better suited for svn.
|
||||
- Picled files are faster.
|
||||
|
||||
## File headers
|
||||
|
||||
Header lines must begin on the first line in the file. Header lines are of the form:
|
||||
|
||||
```
|
||||
# keyword : value
|
||||
#keyword:value
|
||||
# keyword :value
|
||||
```
|
||||
|
||||
Where an optional number of whitespace characters can be put between the different units on the line. The # sign at the start of the line is a traditional UNIX comment sign, and makes it easier for other programs to ignore those lines.
|
||||
20
wiki/help/shortcuts.md
Normal file
20
wiki/help/shortcuts.md
Normal file
@@ -0,0 +1,20 @@
|
||||
Keyboard shortcuts in Fluents, written in Emacs syntax. I.e. C-x means "press control and x". Equivalently M-x is "meta x".
|
||||
|
||||
## Main:
|
||||
|
||||
| | |
|
||||
|----------|-----------------------------------------------------------------|
|
||||
| C-+ | Show only current plot. |
|
||||
| C-- | Show four plots. |
|
||||
| C-arrows | Move focus between views. |
|
||||
| C-n | Create new project. This brings up a workflow selection window. |
|
||||
| C-q | Quit |
|
||||
| M-l | Activate "Log" tab. |
|
||||
| M-s | Activate "Selections" tab. |
|
||||
|
||||
## Selections:
|
||||
|
||||
| | |
|
||||
|---------|--------------|
|
||||
| shift | Union |
|
||||
| control | Intersection |
|
||||
18
wiki/help/tasks/pca.md
Normal file
18
wiki/help/tasks/pca.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Principal Component Analysis
|
||||
|
||||
The principal component analysis (PCA) task.
|
||||
|
||||
## Input
|
||||
|
||||
## Options
|
||||
|
||||
## Output
|
||||
|
||||
- Score matrix
|
||||
- Loadings matrix
|
||||
|
||||
## Plots
|
||||
|
||||
- Score plot
|
||||
- Loadings plot
|
||||
- Profiles
|
||||
23
wiki/help/tasks/pls.md
Normal file
23
wiki/help/tasks/pls.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# Principal Component Analysis
|
||||
|
||||
The principal component analysis (PCA) task.
|
||||
|
||||
## Input
|
||||
|
||||
- X
|
||||
- Y
|
||||
|
||||
## Options
|
||||
|
||||
|
||||
## Output
|
||||
|
||||
- Score matrix
|
||||
- Loadings matrix
|
||||
|
||||
## Plots
|
||||
|
||||
- Score plot
|
||||
- X loadings plot
|
||||
- Y loadings plot
|
||||
- Profiles
|
||||
Reference in New Issue
Block a user