1 changed files with 20 additions and 65 deletions
@ -1,75 +1,30 @@
@@ -1,75 +1,30 @@
|
||||
python_example |
||||
============== |
||||
|
||||
[![Gitter][gitter-badge]][gitter-link] |
||||
|
||||
| CI | status | |
||||
|----------------------|--------| |
||||
| Linux/macOS Travis | [![Travis-CI][travis-badge]][travis-link] | |
||||
| MSVC 2015 | [![AppVeyor][appveyor-badge]][appveyor-link] | |
||||
| conda.recipe | [![Conda Actions Status][actions-conda-badge]][actions-conda-link] | |
||||
| pip builds | [![Pip Actions Status][actions-pip-badge]][actions-pip-link] | |
||||
| [`cibuildwheel`][] | [![Wheels Actions Status][actions-wheels-badge]][actions-wheels-link] | |
||||
|
||||
[gitter-badge]: https://badges.gitter.im/pybind/Lobby.svg |
||||
[gitter-link]: https://gitter.im/pybind/Lobby |
||||
[actions-badge]: https://github.com/pybind/python_example/workflows/Tests/badge.svg |
||||
[actions-conda-link]: https://github.com/pybind/python_example/actions?query=workflow%3A%22Conda |
||||
[actions-conda-badge]: https://github.com/pybind/python_example/workflows/Conda/badge.svg |
||||
[actions-pip-link]: https://github.com/pybind/python_example/actions?query=workflow%3A%22Pip |
||||
[actions-pip-badge]: https://github.com/pybind/python_example/workflows/Pip/badge.svg |
||||
[actions-wheels-link]: https://github.com/pybind/python_example/actions?query=workflow%3AWheels |
||||
[actions-wheels-badge]: https://github.com/pybind/python_example/workflows/Wheels/badge.svg |
||||
[travis-link]: https://travis-ci.org/pybind/python_example |
||||
[travis-badge]: https://travis-ci.org/pybind/python_example.svg?branch=master&status=passed |
||||
[appveyor-link]: https://ci.appveyor.com/project/wjakob/python-example |
||||
<!-- TODO: get a real badge link for appveyor --> |
||||
[appveyor-badge]: https://travis-ci.org/pybind/python_example.svg?branch=master&status=passed |
||||
|
||||
An example project built with [pybind11](https://github.com/pybind/pybind11). |
||||
This requires Python 3.6+; for older versions of Python, check the commit |
||||
history. |
||||
|
||||
Installation |
||||
------------ |
||||
|
||||
- clone this repository |
||||
- `pip install ./python_example` |
||||
|
||||
CI Examples |
||||
----------- |
||||
|
||||
There are examples for CI in `.github/workflows`. A simple way to produces |
||||
binary "wheels" for all platforms is illustrated in the "wheels.yml" file, |
||||
using [`cibuildwheel`][]. You can also see a basic recipe for building and |
||||
testing in `pip.yml`, and `conda.yml` has an example of a conda recipe build. |
||||
- change directory to folder `stormpci_bin_reader` |
||||
- run shell command `pip install .` |
||||
|
||||
|
||||
Building the documentation |
||||
-------------------------- |
||||
|
||||
Documentation for the example project is generated using Sphinx. Sphinx has the |
||||
ability to automatically inspect the signatures and documentation strings in |
||||
the extension module to generate beautiful documentation in a variety formats. |
||||
The following command generates HTML-based reference documentation; for other |
||||
formats please refer to the Sphinx manual: |
||||
|
||||
- `cd python_example/docs` |
||||
- `make html` |
||||
|
||||
License |
||||
------- |
||||
|
||||
pybind11 is provided under a BSD-style license that can be found in the LICENSE |
||||
file. By using, distributing, or contributing to this project, you agree to the |
||||
terms and conditions of this license. |
||||
|
||||
Test call |
||||
--------- |
||||
|
||||
```python |
||||
import python_example |
||||
python_example.add(1, 2) |
||||
``` |
||||
Need binary file from new LDN system for tests. |
||||
|
||||
[`cibuildwheel`]: https://cibuildwheel.readthedocs.io |
||||
```python |
||||
from stormpci_bin_reader import StrikeReader |
||||
|
||||
sr = StrikeReader("2022-04-23-00:00:37.bin") |
||||
strikes = sr.read_all_strikes() |
||||
|
||||
for strike in strikes: |
||||
lts2 = strike.strike.lts2_data |
||||
print( |
||||
lts2.year, |
||||
lts2.month, |
||||
lts2.day, |
||||
lts2.hours, |
||||
lts2.minutes, |
||||
lts2.seconds + lts2.TS_time / lts2.TS_Osc, |
||||
) |
||||
``` |
Loading…
Reference in new issue