Skip to content

Commit

Permalink
Merge pull request #1156 from wright-group/fix-build
Browse files Browse the repository at this point in the history
Fix build
  • Loading branch information
kameyer226 authored Feb 22, 2024
2 parents cb21900 + 594db63 commit 1b4cd5c
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 11 deletions.
11 changes: 6 additions & 5 deletions docs/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ wt5

The wt5 command is meant to provide easy access to wt5 files and some basic wt5 properties.

Use ``wt5 glob`` to quickly probe a folder for wt5s contained inside
Use ``wt5 glob`` to quickly probe a folder for wt5s contained inside.

.. code-block:: shell
> wt5 glob -d path/to/datasets
Expand All @@ -36,10 +37,10 @@ Use ``wt5 glob`` to quickly probe a folder for wt5s contained inside
WrightTools\datasets\wt5\v1.0.1\MoS2_TrEE_movie.wt5
Use ``wt5 explore`` to see details of wt5s within a folder, as the option of quick load a wt5.

.. code-block:: shell
> wt5 explore -d path/to/data/folders
"
┏━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━┓
┃ ┃ path ┃ size (MB) ┃ created ┃ name ┃ shape ┃ axes ┃ variables ┃ channels ┃
┡━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━┩
Expand All @@ -48,10 +49,11 @@ Use ``wt5 explore`` to see details of wt5s within a folder, as the option of qui
│ 2 │ WrightTools\datasets\wt5\v1.0.1\MoS2_TrEE_movie.wt5 │ 2.3 │ 2018-06-11 16:41:47 │ _001_dat │ (41, 41, 23) │ ('w2', 'w1=wm', 'd2') │ 7 │ 6 │
└───┴─────────────────────────────────────────────────────┴───────────┴─────────────────────┴───────────────┴──────────────┴───────────────────────┴───────────┴──────────┘
Specify an index to load that entry. Use `t` to rerender table. Use no argument to exit.
"
Use ``wt5 load`` to quickly open an interactive python console with your wt5 data pre-loaded.

.. code-block:: shell
> wt5 load path\to\data_file.wt5
--- INTERACTING --- (to continue, call exit() or quit())
>>> import WrightTools as wt
Expand All @@ -63,11 +65,10 @@ Use ``wt5 load`` to quickly open an interactive python console with your wt5 dat
Use ``wt5 tree`` to see a quick tree structure of a wt5 file.
.. code-block:: shell
> wt5 tree path\to\data
"
/ (...\felu75fe.wt5) (25, 256)
├── axes (2): w2 (wn), w2-wa (wn)
├── constants (0):
└── channels (1): array_signal
"
13 changes: 7 additions & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,18 @@
import glob
import os
import sys
import sphinx_gallery

# import sphinx_gallery
import math
import pathlib


# --- define -------------------------------------------------------------------------------------


here = os.path.abspath(os.path.dirname(__file__))
here = pathlib.Path(__file__).resolve().parent

with open(os.path.join(os.path.dirname(here), "WrightTools", "VERSION")) as version_file:
with open(here.parent / "WrightTools" / "VERSION") as version_file:
version = version_file.read().strip()


Expand All @@ -38,7 +40,7 @@
# documentation root, use os.path.abspath to make it absolute, like shown here.

sys.path.insert(0, os.path.abspath("."))
sys.path.insert(0, os.path.abspath("../WrightTools"))
sys.path.insert(0, here.parent / "WrightTools")


# --- general configuration ----------------------------------------------------------------------
Expand Down Expand Up @@ -240,10 +242,9 @@ def reset_wt(gallery_conf, fname):


sphinx_gallery_conf = {
"examples_dirs": "../examples",
"examples_dirs": here.parent / "examples",
"filename_pattern": "/*.py",
"gallery_dirs": "auto_examples",
"download_section_examples": False,
"backreferences_dir": os.path.join("gen_modules", "backreferences"),
"reset_modules": ["matplotlib", reset_wt],
}
Expand Down

0 comments on commit 1b4cd5c

Please sign in to comment.