Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
CSSFrancis authored Aug 15, 2024
1 parent 70fa2b3 commit 5bffed4
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
DE API - Python
===============

The DE API provides python bindings for basic operations for controlling the DEServer. This API isn't functional without
a working copy of DEServer and a Direct Electron Detector.


Installation
------------

The python api can be installed using either `pip` or `anaconda`.


Installing using pip

```bash
$ pip install deapi
```

Installing using conda

```bash
$ conda install -c conda-forge deapi
```

Usage and documentation is hosted here.

0 comments on commit 5bffed4

Please sign in to comment.