Skip to content
API documentation and clients for the daptics.ai design of experiments engine
Python Jupyter Notebook Mako
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
pdoc/templates
pydocmd
python_client
.gitignore
.grenrc.json
CHANGELOG.md
LICENSE
README.md
mkdocs.yml

README.md

daptics API

This is the README documentation for the daptics design of experiments GraphQL API and the Python API client.

Links

To use the daptics API, you must first register at the https://daptics.ai to establish your login and password for API authentication.

Python Client

The python_client folder contains the Python GraphQL client, daptics_client.py, and several interactive Python notebooks for experimenting with the API.

Follow the instructions in the README.md file in that folder to set up a local Jupyter Notebook server if you do not have access to a server that can open .ipynb files.

GraphQL API Documentation

  1. Install graphql-markdown

  2. Then in pydocmd folder, run:

graphql-markdown --no-toc --title 'Daptics GraphQL API' http://inertia.protolife.com:8080/api >graphql_api.md

Python Client Documentation and MkDocs Build

  1. Install these tools: pdoc3 and MkDocs.

  2. Create Markdown documentation for the daptics_client.py file using pdoc3. In the python_client folder, run: pdoc --pdf --force --template-dir ../pdoc/templates daptics_client >../pydocmd/daptics_client.md

  3. Then build the entire "Read the Docs" site, using mkdocs. In the root project folder, where the mkdocs.yml configuration file is located, run: mkdocs build

Html and Markdown files will be produced in the docs folder.

Using Jupytext to Extract and Sync to Python Source Files

  1. Install jupytext

  2. Set up metadata in any ipynb file that has Python code: jupytext --set-formats ipynb,python//py:light 03_SimpleTutorial.ipynb

  3. Export Python code to /python subdirectory: jupytext --from ipynb --to python//py:light 03_SimpleTutorial.ipynb

  4. Edit Python code as needed. Or when you run in Jupyter notebook, and make changes, the corresponding Python file will be kept up to date!

  5. Rebuild notebook from Python file without outputs (do this before checking into version control): jupytext --from python//py:light --to notebook python/03_SimpleTutorial.py

You can also use jupyter nbconvert to remove all output from .ipynb files:

jupyter nbconvert 03_SimpleTutorial.ipynb --to notebook --ClearOutputPreprocessor.enabled=True --inplace

Automated Release Notes by gren

You can’t perform that action at this time.