simput
Provide a simple way to write input simulation files.
Last updated a year ago by sebastien.jourdain .
BSD-3-Clause · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install simput -g
SYNC missed versions from official npm registry.

Simput

Goal

To provide a simple way to write input simpulation files.

Installation

$ npm install -g simput

Usage

After installing the package you will get one executable Simput with the following set of options:

$ Simput

  Usage: Simput [options]

  Options:

    -h, --help                    output usage information
    -V, --version                 output the version number

    -i, --input [file|directory]  Input file or directory
    -o, --output [directory]      Output directory to output to
    -t, --type [type]             Type of input

    -s, --silent                  Do not open the browser

    -c, --compile [directory]     Directory to compile files
    -m, --minify                  Minify compiled file

Examples

$ Simput -p

Starts a server and opens your web browser, showing a landing page with a choice of inputs which you can create.

Demos

There are a few supplied demos in the folder types, each have their own README.

  • vCard is the simplest example, with a single type of output.
  • oscillator is a bit more complex, because it derives from a real benchmarking application meant to exercise in-situ analyses on hpc systems.
  • pyfr and vera produce input files for real applications, and are realistically complex.

Development

$ git clone --recursive https://github.com/Kitware/simput.git
$ cd simput
$ npm install
$ npm run build
$ npm link
$ Simput

  Usage: Simput [options]

  Options:

    -h, --help                    output usage information
    -V, --version                 output the version number

    -i, --input [file|directory]  Input file or directory
    -o, --output [directory]      Output directory to output to
    -t, --type [type]             Type of input

    -s, --silent                  Do not open the browser

    -c, --compile [directory]     Directory to compile files
    -m, --minify                  Minify compiled file

Then to compile pyfr and open a development server which watches for another compile:

$ npm run type:pyfr
$ npm run dev

Creating a new simulation type

In a separate location create a folder for your type:

# Replace [mytype] with your type name.
mkdir [mytype]
cd [mytype]
git init

Create the folder and file structure:

  • /src
    • /lang
      • /[language] e.g. "en", "fr"
        • label.json, attribute and property labels.
        • /help, help dialogs, recommended, not required
          • /[folders for each attribute]
            • [file for each property, contents are html]
    • /templates
      • [template file and helpers]
    • model.js, primary data structure.
    • convert.js, converts the model into the simulation deck format.
    • parse.js, converts a complete input file to the simput model; recommended, not required.
  • /samples, empty or partially full sample datasets; recommended, not required.
  • /versions, an output folder for your compiled type; recommended, not required.
  • README.md, a description of your type; recommended, not required.

For examples of each take a look at types/demo

Optional: Add the type as a submodule to this repository

It's critical that these are executed in order

# start in the [mytype] directory from above. Replace [mytype] with your type name below.
git checkout -b type-[mytype] #replace 'mytype' with the name of the new type
git commit -m "initial commit"
git remote add origin https://github.com/Kitware/simput.git
git push origin type-[mytype] # where 'mytype-branch' is the current branch name
cd [your simput repo] # usually cd ../..
git submodule add -b type-[mytype] https://github.com/kitware/simput types/[mytype]
git add .gitmodules types/
git commit -m "added [mytype]"
git push

Add to compilation and landing page

Simput changed to a Vue.js framework, and no longer has the ability to dynamically add and load types - they must be present when Simput is built by webpack.

Add another script to package.json which compiles your type.

Add a call to Simput.registerType() for your type in static/index.html

This will likely change soon.

Licensing

Simput is licensed under BSD Clause 3.

Getting Involved

Fork our repository and do great things. At Kitware, we've been contributing to open-source software for 15 years and counting, and want to make Simput useful to as many people as possible.

Current Tags

  • 3.4.1                                ...           latest (a year ago)
  • 1.2.1                                ...           simput@1.2.1 (4 years ago)
  • 1.2.2                                ...           simput@1.2.2 (4 years ago)
  • 1.2.3                                ...           simput@1.2.3 (4 years ago)
  • 1.2.4                                ...           simput@1.2.4 (4 years ago)
  • 1.2.5                                ...           simput@1.2.5 (4 years ago)

140 Versions

  • 3.4.1                                ...           a year ago
  • 3.4.0                                ...           a year ago
  • 3.3.2                                ...           a year ago
  • 3.3.1                                ...           a year ago
  • 3.3.0                                ...           a year ago
  • 3.2.23                                ...           a year ago
  • 3.2.22                                ...           a year ago
  • 3.2.21                                ...           a year ago
  • 3.2.20                                ...           a year ago
  • 3.2.19                                ...           2 years ago
  • 3.2.18                                ...           2 years ago
  • 3.2.17                                ...           2 years ago
  • 3.2.16                                ...           2 years ago
  • 3.2.15                                ...           2 years ago
  • 3.2.14                                ...           2 years ago
  • 3.2.13                                ...           2 years ago
  • 3.2.12                                ...           2 years ago
  • 3.2.11                                ...           2 years ago
  • 3.2.10                                ...           2 years ago
  • 3.2.9                                ...           2 years ago
  • 3.2.8                                ...           2 years ago
  • 3.2.7                                ...           2 years ago
  • 3.2.6                                ...           2 years ago
  • 3.2.5                                ...           2 years ago
  • 3.2.4                                ...           2 years ago
  • 3.2.3                                ...           2 years ago
  • 3.2.2                                ...           2 years ago
  • 3.2.1                                ...           2 years ago
  • 3.2.0                                ...           2 years ago
  • 3.1.10                                ...           2 years ago
  • 3.1.9                                ...           2 years ago
  • 3.1.8                                ...           2 years ago
  • 3.1.7                                ...           2 years ago
  • 3.1.6                                ...           2 years ago
  • 3.1.5                                ...           2 years ago
  • 3.1.4                                ...           2 years ago
  • 3.1.3                                ...           2 years ago
  • 3.1.2                                ...           2 years ago
  • 3.1.1                                ...           2 years ago
  • 3.1.0                                ...           2 years ago
  • 3.0.2                                ...           2 years ago
  • 3.0.1                                ...           2 years ago
  • 3.0.0                                ...           2 years ago
  • 2.2.22                                ...           2 years ago
  • 2.2.21                                ...           2 years ago
  • 2.2.20                                ...           2 years ago
  • 2.2.19                                ...           2 years ago
  • 2.2.18                                ...           2 years ago
  • 2.2.17                                ...           2 years ago
  • 2.2.16                                ...           2 years ago
  • 2.2.15                                ...           2 years ago
  • 2.2.14                                ...           2 years ago
  • 2.2.13                                ...           2 years ago
  • 2.2.12                                ...           2 years ago
  • 2.2.11                                ...           2 years ago
  • 2.2.10                                ...           2 years ago
  • 2.2.9                                ...           2 years ago
  • 2.2.8                                ...           2 years ago
  • 2.2.7                                ...           2 years ago
  • 2.2.6                                ...           2 years ago
  • 2.2.5                                ...           2 years ago
  • 2.2.4                                ...           2 years ago
  • 2.2.3                                ...           2 years ago
  • 2.2.2                                ...           2 years ago
  • 2.2.1                                ...           2 years ago
  • 2.2.0                                ...           2 years ago
  • 2.1.1                                ...           2 years ago
  • 2.1.0                                ...           2 years ago
  • 2.0.2                                ...           2 years ago
  • 2.0.1                                ...           2 years ago
  • 2.0.0                                ...           2 years ago
  • 1.6.1                                ...           2 years ago
  • 1.6.0                                ...           2 years ago
  • 1.5.0                                ...           2 years ago
  • 1.4.0                                ...           3 years ago
  • 1.3.24                                ...           3 years ago
  • 1.3.23                                ...           3 years ago
  • 1.3.22                                ...           3 years ago
  • 1.3.21                                ...           3 years ago
  • 1.3.20                                ...           4 years ago
  • 1.3.19                                ...           4 years ago
  • 1.3.18                                ...           4 years ago
  • 1.3.17                                ...           4 years ago
  • 1.3.16                                ...           4 years ago
  • 1.3.15                                ...           4 years ago
  • 1.3.14                                ...           4 years ago
  • 1.3.13                                ...           4 years ago
  • 1.3.12                                ...           4 years ago
  • 1.3.11                                ...           4 years ago
  • 1.3.10                                ...           4 years ago
  • 1.3.9                                ...           4 years ago
  • 1.3.8                                ...           4 years ago
  • 1.3.7                                ...           4 years ago
  • 1.3.6                                ...           4 years ago
  • 1.3.5                                ...           4 years ago
  • 1.3.4                                ...           4 years ago
  • 1.3.3                                ...           4 years ago
  • 1.3.2                                ...           4 years ago
  • 1.3.1                                ...           4 years ago
  • 1.3.0                                ...           4 years ago
  • 1.2.8                                ...           4 years ago
  • 1.2.7                                ...           4 years ago
  • 1.2.6                                ...           4 years ago
  • 1.2.5                                ...           4 years ago
  • 1.2.4                                ...           4 years ago
  • 1.2.3                                ...           4 years ago
  • 1.2.1                                ...           4 years ago
  • 1.2.2                                ...           4 years ago
  • 1.2.0                                ...           4 years ago
  • 1.1.14                                ...           4 years ago
  • 1.1.13                                ...           4 years ago
  • 1.1.12                                ...           4 years ago
  • 1.1.11                                ...           4 years ago
  • 1.1.10                                ...           4 years ago
  • 1.1.9                                ...           4 years ago
  • 1.1.8                                ...           4 years ago
  • 1.1.7                                ...           4 years ago
  • 1.1.6                                ...           4 years ago
  • 1.1.5                                ...           4 years ago
  • 1.1.4                                ...           4 years ago
  • 1.1.3                                ...           4 years ago
  • 1.1.2                                ...           4 years ago
  • 1.1.1                                ...           4 years ago
  • 1.1.0                                ...           4 years ago
  • 1.0.15                                ...           4 years ago
  • 1.0.14                                ...           4 years ago
  • 1.0.13                                ...           4 years ago
  • 1.0.12                                ...           4 years ago
  • 1.0.11                                ...           4 years ago
  • 1.0.10                                ...           4 years ago
  • 1.0.9                                ...           4 years ago
  • 1.0.8                                ...           5 years ago
  • 1.0.7                                ...           5 years ago
  • 1.0.6                                ...           5 years ago
  • 1.0.5                                ...           5 years ago
  • 1.0.4                                ...           5 years ago
  • 1.0.3                                ...           5 years ago
  • 1.0.2                                ...           5 years ago
  • 1.0.1                                ...           5 years ago
  • 1.0.0                                ...           5 years ago
Downloads
Today 0
This Week 1
This Month 1
Last Day 0
Last Week 0
Last Month 0
Dependencies (17)
Dev Dependencies (4)
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |