From dd08a4e516f26f8726600dd88fbcc392b6bcfd0d Mon Sep 17 00:00:00 2001 From: Adriaan Rol Date: Wed, 12 Aug 2020 17:26:32 +0200 Subject: [PATCH] fixed typo in PyPI shield --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 5574bd1..1442cb3 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ -# AutoDepGraph +# AutoDepGraph -[![PyPI](https://img.shields.io/pypi/v/adaptive.svg)](https://pypi.python.org/pypi/autodepgraph) +[![PyPI](https://img.shields.io/pypi/v/autodepgraph.svg)](https://pypi.python.org/pypi/autodepgraph) [![Build Status](https://travis-ci.org/AdriaanRol/AutoDepGraph.svg?branch=master)](https://travis-ci.org/AdriaanRol/AutoDepGraph) -[![Codacy Badge](https://api.codacy.com/project/badge/Grade/ae46c58617ff45df9ac98446b3dc34ac)](https://www.codacy.com/app/adriaan-rol/AutoDepGraph?utm_source=github.com&utm_medium=referral&utm_content=AdriaanRol/AutoDepGraph&utm_campaign=Badge_Grade) +[![Codacy Badge](https://api.codacy.com/project/badge/Grade/ae46c58617ff45df9ac98446b3dc34ac)](https://www.codacy.com/app/adriaan-rol/AutoDepGraph?utm_source=github.com&utm_medium=referral&utm_content=AdriaanRol/AutoDepGraph&utm_campaign=Badge_Grade) [![Coverage Status](https://coveralls.io/repos/github/AdriaanRol/AutoDepGraph/badge.svg?branch=master)](https://coveralls.io/github/AdriaanRol/AutoDepGraph?branch=master) [![DOI](https://zenodo.org/badge/85987885.svg)](https://zenodo.org/badge/latestdoi/85987885) -AutoDepGraph is a framework for using dependency graphs to calibrate a system. It is heavily inspired by ["Physical qubit calibration on a directed acyclic graph"](https://arxiv.org/abs/1803.03226). +AutoDepGraph is a framework for using dependency graphs to calibrate a system. It is heavily inspired by ["Physical qubit calibration on a directed acyclic graph"](https://arxiv.org/abs/1803.03226). ## Overview AutoDepGraph consists of two main classes, the CalibrationNode and the Graph. @@ -21,11 +21,11 @@ A CalibrationNode contains: + Bad (red): calibration or check has failed + unknown (grayed): checks of the node should be run + active (blue): calibration or check in progress - - parents: the nodes it depends on + - parents: the nodes it depends on - children: nodes that depend on this node - check_function : name of function to be executed when check is called. This can be a method of another instrument. - calibrate_function : name of function to be executed when calibrate is called. This can be a method of another instrument. - - calibration_timeout: time in (s) after which a calibration times out. + - calibration_timeout: time in (s) after which a calibration times out. - function - execute or call @@ -35,8 +35,8 @@ A CalibrationNode contains: - calibrate + Executes the calibration routines of the node -A Graph is a container of nodes, it is used for: -- new graphs can be created by instantiating a graph and then using the add_node method to define new nodes. +A Graph is a container of nodes, it is used for: +- new graphs can be created by instantiating a graph and then using the add_node method to define new nodes. - loading and saving the graph - real-time visualization using pyqtgraph - state of the node determines color of a node @@ -45,7 +45,7 @@ A Graph is a container of nodes, it is used for: ![Example calibration graph](docs/example_graph.png) -## Examples +## Examples For an introductory example see the example notebook. If you want to see how to use a specific function, see the tests located in the autodepgraph/tests folder. ## Installation @@ -54,8 +54,8 @@ For an introductory example see the example notebook. If you want to see how to - navigate to the repository and run `pip install -e .` - verify success of installation by running `py.test` -#### N.B. windows can be "problematic" -Installation on windows is a bit more difficult, this relates mostly to the installation of pygraphviz. To install graphviz and pygraphviz on windows follow these steps: +#### N.B. windows can be "problematic" +Installation on windows is a bit more difficult, this relates mostly to the installation of pygraphviz. To install graphviz and pygraphviz on windows follow these steps: - get the 64 bit version of ![graphviz for windows](https://github.com/mahkoCosmo/GraphViz_x64/), copy it to e.g., program files and add the bin folder to the system path. - the 64 bit version lacks the libxml2.dll, you most likely have this from some other program. You can find this by searching for `libxml2.dll` in the program files folder. After that just copy paste it to the bin folder of graphviz. @@ -69,4 +69,4 @@ python setup.py install --include-path="C:\Program Files\graphviz-2.38_x64\inclu - then install autodepgraph and test the installation using `py.test` ## Acknowledgements -I would like to thank Julian Kelly for the idea of using a dependency graph for calibrations and for early discussions. I would like to thank Joe Weston for discussions and help in working out the initial design. I would like to acknowledge Livio Ciorciaro for disucssions and as a coauthor of this project. +I would like to thank Julian Kelly for the idea of using a dependency graph for calibrations and for early discussions. I would like to thank Joe Weston for discussions and help in working out the initial design. I would like to acknowledge Livio Ciorciaro for disucssions and as a coauthor of this project.