Skip to content

Commit b48acc2

Browse files
committed
Update documentation
1 parent 77263c8 commit b48acc2

File tree

4 files changed

+340
-36
lines changed

4 files changed

+340
-36
lines changed

docs/docs/cookbook.ipynb

Lines changed: 317 additions & 12 deletions
Large diffs are not rendered by default.

docs/docs/index.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,11 @@ timestreams that do not compress well with DEFLATE algorithms used by zip /
1010
gzip. This type of data is found in audio signals, scientific timestreams, etc.
1111

1212
In the `flacarray` package we use only a small subset of features found in the
13-
libFLAC library. In particular, each data stream is compressed as a single, 32
14-
bit "channel". Stream data consisting of 32 bit integers (or 64 bit integers
15-
spanning a peak-to-peak range that fits into 32 bits) are compressed in a
16-
loss-less fashion. Floating point data is converted to 32 bit integers with a
17-
user-specified precision or quantization.
13+
libFLAC library. In particular, each data stream is compressed as either one or
14+
two 32 bit "channels". Stream data consisting of 32 or 64 bit integers are
15+
compressed in a loss-less fashion. Floating point data is converted to either 32
16+
or 64 bit integers with a user-specified precision or quantization.
1817

1918
If you are specifically working with audio data and want to write flac format
20-
files, you should look at other software tools such as
19+
audio files, you should look at other software tools such as
2120
[pyflac](https://github.com/sonos/pyFLAC).

docs/docs/install.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ development libraries installed.
3838
If you have conda available, you can create an environment will all the
3939
dependencies you need to build flacarray from source. For this example, we
4040
create an environment called "flacarray". First create the env with all
41-
dependencies and activate it (FIXME, add a requirements file for dev):
41+
dependencies and activate it (FIXME: add a requirements file for dev):
4242

4343
conda create -n flacarray \
4444
c-compiler numpy libflac cython meson-python pkgconfig
@@ -53,7 +53,7 @@ To build and install the package.
5353

5454
To also work on docs, install additional packages:
5555

56-
conda install mkdocs mkdocstrings mkdocs-jupyter
56+
conda install mkdocs mkdocstrings mkdocstrings-python mkdocs-jupyter
5757
pip install mkdocs-print-site-plugin
5858

5959
### Other Ways of Building

docs/docs/tutorial.ipynb

Lines changed: 16 additions & 16 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)