Skip to content

Commit 10541fd

Browse files
committed
Fix code block indents and pyspi stylization
1 parent 6671835 commit 10541fd

File tree

3 files changed

+14
-5
lines changed

3 files changed

+14
-5
lines changed

docs/source/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
# -- Project information
44

5-
project = 'PySPI'
5+
project = 'pyspi'
66
copyright = '2022, Oliver M. Cliff'
77
author = 'Oliver M. Cliff'
88

9-
release = '0.3'
10-
version = '0.3.0'
9+
release = '0.4'
10+
version = '0.4.0'
1111

1212
# -- General configuration
1313

docs/source/faq.rst

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ One user reported the following error when installing `pyspi` on a MacBook Air a
1919
OSError: [Errno 0] JVM DLL not found /Library/Java/JavaVirtualMachines/jdk-19.jdk/Contents/Home/lib/libjli.dylib
2020
2121
22-
This issue is similar to those reported `here <https://stackoverflow.com/questions/71504214/jvm-dll-not-found-but-i-can-clearly-see-the-file>`_ and `here <https://github.com/jpype-project/jpype/issues/994>`_. This issue can arise from the version of OpenJDK identified as the system default
22+
This issue is similar to those reported `here <https://stackoverflow.com/questions/71504214/jvm-dll-not-found-but-i-can-clearly-see-the-file>`_ and `here <https://github.com/jpype-project/jpype/issues/994>`_; it can arise from the version of OpenJDK identified as the system default. Some Java versions don't include all of the binary (DLL) files that `pyspi` looks for.
2323

2424
We recommend following this `helpful tutorial <https://blog.bigoodyssey.com/how-to-manage-multiple-java-version-in-macos-e5421345f6d0>`_ by Chamika Kasun to install `AdoptOpenJDK <https://adoptopenjdk.net/index.html>`_. In a nutshell, here are the steps you should run:
2525

@@ -33,48 +33,57 @@ Install homebrew if you don't already have it:
3333
Install `jenv` as your Java version manager:
3434

3535
.. code-block::
36+
3637
$ brew install jenv
3738
3839
3940
Add `jenv` to your shell's configuration file (e.g. `.bashrc` if you use `bash`):
4041

4142
.. code-block::
43+
4244
$ export PATH="$HOME/.jenv/bin:$PATH"
4345
$ eval "$(jenv init -)"
4446
4547
Source your shell's configuration file:
4648

4749
.. code-block::
50+
4851
$ source ~/.bashrc # If you use bash
4952
5053
Confirm proper installation of `jEnv`:
5154

5255
.. code-block::
56+
5357
$ jenv doctor
5458
5559
Even if this returns some errors, as long as you see `Jenv is correctly loaded`, you're all set. We recommend using `AdoptOpenJDK` version 11, which you can install with the following command:
5660

5761
.. code-block::
62+
5863
$ brew install AdoptOpenJDK/openjdk/adoptopenjdk11
5964
6065
Now, you will need to add your `AdoptOpenJDK` path to your `jEnv` environments. First, you can find where your jdk files are installed with the following command:
6166

6267
.. code-block::
68+
6369
$ /usr/libexec/java_home -V
6470
6571
This will list all your installed java JDK versions. Locate the one for `AdoptOpenJDK` version 11 and paste the path:
6672

6773
.. code-block::
74+
6875
$ jenv add <path_to_adopt_open_jdk_11>
6976
7077
Confirm `AdoptOpenJDK` version 11 was added to `jEnv`:
7178

7279
.. code-block::
80+
7381
$ jenv versions
7482
7583
You can set `AdoptOpenJDK` version 11 as your global Java version with the following:
7684

7785
.. code-block::
86+
7887
$ jenv global <AdoptOpenJDK version>
7988
$ # example:
8089
$ jenv global 11.0

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Welcome to PySPI's documentation!
1+
Welcome to pyspi's documentation!
22
===================================
33

44
**pyspi** (/pie'spy/) is a Python library for simultaneously evaluating hundreds of pairwise interactions directly from multivariate time-series data.

0 commit comments

Comments
 (0)