# Code container interface
The idea here is to define as simple interface that can be implemented by
container containing various codes, to allow them to be used with the OpenChemistry
framework. The interface consists of a simple CLI defined below and a could of
schemas describing what CLI should produce or consume.
## CLI
The container should support a CLI with the following options:
### Describe
This option is used to query the container for a description of the code. When the
container is run using this option it should return descriptor JSON document
conforming to the following [schema](code.schema.json), outlined the input/outputs and various metadata
associated with the code.
```
-d |--describe
```
### Input
These options should accept a space separated list of file paths to the data files
that have been mounted into the container. The particular options and formats
provides will depend on the JSON description. *TODO Need examples of other input options we would like to support ( all our current code just take the geometry ).*
```
-g | --geometry
```
### Output
This option should accept a file path that should be used to write the output
produced by the code, it should be written in the formatted specified in the
descriptor. *TODO We probably need to support multiple outputs.*
```
-o | --output
```
### Parameters
This option should accept a file path to a JSON file containing the parameters
to control the execution of the execution of the code. This is the information
that should be used to generate the appropriate input 'deck' for the
specific code. The following [schema](params.schema.json) describes this format. The basic parameters
are those that are understood by the OpenChemsitry infrastructure, such as
basis. They have enumerations defining their values, they need to be mapped
to code specfic values. The document can also contain code specific values pass by they caller.
```
-p | --parameters
```
没有合适的资源?快使用搜索试试~ 我知道了~
资源推荐
资源详情
资源评论
收起资源包目录
openchemistry-0.0.18.dev17.tar.gz (44个子文件)
openchemistry-0.0.18.dev17
PKG-INFO 540B
README.rst 110B
openchemistry.egg-info
PKG-INFO 540B
requires.txt 75B
SOURCES.txt 1KB
top_level.txt 14B
dependency_links.txt 1B
taskflows
taskflows
__init__.py 23KB
utils
pull.py 3KB
avogadro.py 273B
__init__.py 142B
openchemistry
_molecule.py 1KB
recipes.py 880B
_visualization.py 6KB
_notebook.py 2KB
_calculation.py 9KB
_data.py 4KB
__init__.py 225B
io
constants.py 69B
nwchemJson.py 837B
cjson.py 153B
utils.py 1KB
psi4.py 4KB
__init__.py 101B
base.py 499B
_girder.py 2KB
api.py 6KB
_utils.py 4KB
setup.cfg 59B
docker
Dockerfile 212B
celery
celery.env 0B
Dockerfile 681B
config.json 283B
examples
openchemistry.ipynb 4KB
openchemistry_test.ipynb 177KB
openchemistry_test.py 354B
setup.py 2KB
.gitignore 89B
interface
code.schema.json 3KB
examples
psi4.json 386B
chemml.json 270B
nwchem.json 231B
README.md 2KB
.circleci
config.yml 859B
共 44 条
- 1
资源评论
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功