diff --git a/.gitignore b/.gitignore index 347484d558fad860d08ee8bfe6bb6cabb9d109c9..c87d741c858fd20318e53c775be3ca31649f57a2 100644 --- a/.gitignore +++ b/.gitignore @@ -1,81 +1,3 @@ - -# Created by https://www.gitignore.io/api/node - -### Node ### -# Logs -logs -*.log -npm-debug.log* -yarn-debug.log* -yarn-error.log* - -# Runtime data -pids -*.pid -*.seed -*.pid.lock - -# Directory for instrumented libs generated by jscoverage/JSCover -lib-cov - -# Coverage directory used by tools like istanbul -coverage - -# nyc test coverage -.nyc_output - -# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) -.grunt - -# Bower dependency directory (https://bower.io/) -bower_components - -# node-waf configuration -.lock-wscript - -# Compiled binary addons (http://nodejs.org/api/addons.html) -build/Release - -# Dependency directories -node_modules/ -jspm_packages/ - -# Typescript v1 declaration files -typings/ - -# Optional npm cache directory -.npm - -# Optional eslint cache -.eslintcache - -# Optional REPL history -.node_repl_history - -# Output of 'npm pack' -*.tgz - -# Yarn Integrity file -.yarn-integrity - -# dotenv environment variables file -.env - - -# End of https://www.gitignore.io/api/node - -# built files -dist/ -# docs cache/build -styleguide/ - -flow-typed/ - -coverage/ - -# user conf file for app -user_conf.json - # pycache __pycache__ @@ -109,6 +31,5 @@ miniconda.cached/ conda/recipe_append.yaml conda-bld/ -# built JS files -beat/editor/js +# users prefix prefix/ diff --git a/doc/editor.rst b/doc/editor.rst index 56e199ca2756195f220ace03682def4c807f66ef..9686082325db1d239a5773496dec3641032eb834 100644 --- a/doc/editor.rst +++ b/doc/editor.rst @@ -24,7 +24,7 @@ Some of these editors are more complex than others - if you can't figure somethi Generic Editor Features ======================= -.. image:: ./img/editor_generic_breakdown.png +.. .. image:: ./img/editor_generic_breakdown.png 1. `Object Name`: The name of the object being edited. 2. `Validity Flag`: Whether the object as it is in your prefix has JSON metadata that is considered valid by the BEAT system. @@ -40,7 +40,7 @@ Generic Editor Features Database Editor =============== -.. image:: ./img/editor_database_breakdown.png +.. .. image:: ./img/editor_database_breakdown.png 1. `Root Folder field`: The absolute path to the root folder for the data files for this database. This folder is used inside the BEAT system to provide the data files to the database Python code when indexing/executing the database views. 2. `Active Protocol`: Databases can have multiple protocols, but you only edit one at a time. The active protocol is shown, while the others are hidden. The active protocol in this image is "Main". @@ -67,7 +67,7 @@ Database Editor Dataformat Editor ================= -.. image:: ./img/editor_dataformat_breakdown.png +.. .. image:: ./img/editor_dataformat_breakdown.png 1. `Fields`: Dataformats have fields, each with at least a name and a type (which could be any other dataformat, a dictionary, array, string, or number types). 2. `Field Name`: Change the field's (or subfield's) name. @@ -84,7 +84,7 @@ Dataformat Editor Algorithm Editor ================ -.. image:: ./img/editor_algorithm_breakdown.png +.. .. image:: ./img/editor_algorithm_breakdown.png 1. `Analyzer Flag`: Whether or not the algorithm is for analyzer blocks. If this flag is checked, a new algorithm tab, `Results`, will be available for adding & editing the result fields. These result fields are very similar to output fields in normal algorithm groups, but with restricted types. The algorithm shown in the image does not have this field checked, and so is not an analyzer algorithm. 2. `Splittable Flag`: Whether or not the algorithm is splittable (parallelizeable). Only available on non-analyzer algorithms. @@ -106,7 +106,7 @@ Algorithm Editor Toolchain Editor ================ -.. image:: ./img/editor_toolchain_breakdown.png +.. .. image:: ./img/editor_toolchain_breakdown.png 1. `Toolchain Graphical Editor`: Below the "Description" field in the Toolchain Editor in a window showing a custom editor made to graphically edit toolchains. This is a scrollable window, with blocks laid on the lined background. 2. `Menu Bar`: This is the menu bar for the graphical editor, with several buttons to help use this tool: @@ -138,7 +138,7 @@ How to use the Graphical Editor: Experiment Editor ================= -.. image:: ./img/editor_experiment_breakdown.png +.. .. image:: ./img/editor_experiment_breakdown.png 1. `Toolchain Viewer`: This is a stripped-down, read-only version of the the graphical toolchain editor. It lets you see the toolchain for the experiment. Clicking on the background canvas will jump you to the Global Settings section. 2. `Dataset Blocks`: Clicking a dataset block will jump you to that dataset block's settings for this experiment. diff --git a/doc/licenses.md b/doc/licenses.md deleted file mode 100644 index 55f4155d809a7c3e38f933ffe902e233b0f5e820..0000000000000000000000000000000000000000 --- a/doc/licenses.md +++ /dev/null @@ -1,77 +0,0 @@ -| Dependency | License | -| :--------- | :------ | -| ajv | MIT | -| bootstrap | MIT | -| classnames | MIT | -| d3 | BSD 3 Clause | -| fast-levenshtein | MIT | -| fuse.js | Apache 2.0 | -| prop-types | MIT | -| react | MIT | -| react-contextmenu | MIT | -| react-dom | MIT | -| react-popper | MIT | -| react-redux | MIT | -| react-router-dom | MIT | -| react-transition-group | BSD 3 Clause | -| reactstrap | MIT | -| redux | MIT | -| redux-thunk | MIT | -| reselect | MIT | - -| Dev Dependency | License | -| :------------- | :------ | -| babel-core | MIT | -| babel-eslint | MIT | -| babel-loader | MIT | -| babel-plugin-dynamic-import-webpack | MIT | -| babel-plugin-istanbul | BSD 3 Clause | -| babel-plugin-syntax-dynamic-import | MIT | -| babel-plugin-syntax-object-rest-spread | MIT | -| babel-plugin-transform-class-properties | MIT | -| babel-plugin-transform-object-rest-spread | MIT | -| babel-preset-env | MIT | -| babel-preset-react | MIT | -| chai | MIT | -| chai-enzyme | MIT | -| cross-env | MIT | -| css-loader | MIT | -| enzyme | MIT | -| enzyme-adapter-react-16 | MIT | -| eslint | MIT | -| eslint-plugin-compat | MIT | -| eslint-plugin-flowtype | BSD 3 Clause | -| eslint-plugin-import | MIT | -| eslint-plugin-react | MIT | -| flow-bin | MIT | -| html-webpack-harddisk-plugin | MIT | -| html-webpack-plugin | MIT | -| husky | MIT | -| karma | MIT | -| karma-chrome-launcher | MIT | -| karma-coverage | MIT | -| karma-firefox-launcher | MIT | -| karma-mocha | MIT | -| karma-mocha-reporter | MIT | -| karma-sourcemap-loader | MIT | -| karma-webpack | MIT | -| mocha | MIT | -| postcss | MIT | -| postcss-cli | MIT | -| postcss-cssnext | MIT | -| postcss-loader | MIT | -| postcss-smart-import | MIT | -| react-hot-loader | MIT | -| react-test-renderer | MIT | -| redux-devtools | MIT | -| rimraf | ISC | -| sinon | BSD 3 Clause | -| style-loader | MIT | -| stylelint | MIT | -| stylelint-config-standard | MIT | -| svg-inline-loader | MIT | -| uglifyjs-webpack-plugin | MIT | -| webpack | MIT | -| webpack-dev-server | MIT | -| webpack-visualizer-plugin | MIT | -| worker-loader | MIT |