Skip to content

Commit

Permalink
📝 typos, initial pip and setuptools instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
phoebe-p committed Mar 23, 2022
1 parent 909655d commit 502e635
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
5 changes: 3 additions & 2 deletions docs/source/Installation/Solcore_on_Windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ the WSL does not support graphical applications, but it is possible to use Pytho
environment running in Windows (such as VSCode), including plotting capabilities. Step-by-step instructions for
setting up the WSL and accessing it from VSCode are given [here](https://code.visualstudio.com/docs/remote/wsl-tutorial).
Note that to be able to see plots generated during code execution you can right-click on the Python file you want to execute
in VSCode and select 'Run Current File in Python Interactive window'. This has been tested on the Ubuntu20.04 version of the
in VSCode and select 'Run Current File in Python Interactive window'. This has been tested on 64-bit Windows 10 using
the Ubuntu20.04 version of the
WSL (using [WSL 2](https://docs.microsoft.com/en-us/windows/wsl/install#upgrade-version-from-wsl-1-to-wsl-2)); both S4
and the PDD install and run without issues.

Expand Down Expand Up @@ -80,7 +81,7 @@ Checking if everything works
sudo python3 setup.py test
```

This might result in an error saying that quantum mechanics failed because 5\ :sup:`th` decimal place of result doesn’t match.
This might result in an error saying that quantum mechanics failed because the 5th decimal place of result doesn’t match.
You can simply ignore this error. If everything is working correctly, should be able to `import solcore.solar_cell_solver`
without getting warnings about the RCWA solver or PDD.

Expand Down
10 changes: 5 additions & 5 deletions docs/source/Installation/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ This will download Solcore form the Pypi repository and install the package with

**NOTE**: Pip passes the --install-option to all the dependencies of the package and therefore the installation will fail since those dependencies do not have the option "--with_pdd". That is the reason why, for now, Solcore needs to be installed twice: the first one to install Solcore normally with all the dependencies and the second one re-installs Solcore with PDD support.

And that's all!! Solcore should be available to be used as with any Python package::
And that's all! Solcore should be available to be used as with any Python package::

>>> import solcore

Expand Down Expand Up @@ -81,7 +81,7 @@ or::

pip install -e ".[dev]" --install-option="--with_pdd"
Solcore uses *pre-commit* to do a few things before commiting the changes (for example, clearing the output of Jupyter Notebooks). The *pre-commit* package is installed automatically with the above commands, but each user needs to be initialise it before it can work. This can be done with::
Solcore uses *pre-commit* to do a few things before committing the changes (for example, clearing the output of Jupyter Notebooks). The *pre-commit* package is installed automatically with the above commands, but each user needs to be initialise it before it can work. This can be done with::

pre-commit install
Expand All @@ -90,7 +90,7 @@ Check the `pre-commit webpage <https://pre-commit.com/#3-install-the-git-hook-sc
Getting started
^^^^^^^^^^^^^^^

After installing Solcore (or even without installing it), there are a few things you might want to do in order to personalise it and start using it. These are general instructions that, hopefully, should work in most *NIX systems. Check specific instructions for:
After installing Solcore (or even without installing it), there are a few things you might want to do in order to personalise it and start using it. These are general instructions that, hopefully, should work in most \*NIX systems. Check specific instructions for:

- :doc:`Windows 10 <Solcore_on_Windows>`
- :doc:`Mac OS X <Solcore_on_MacOSX>`
Expand All @@ -104,9 +104,9 @@ After installing Solcore (or even without installing it), there are a few things
You can find all the functionality of the :code:`config` object in `The config_tools`_.

2. **Check Solcore examples:** This is the fastest way of getting started. These examples include all the scripts used in the main Solcore paper in the `Journal of Computational Electronics (2018) <https://doi.org/10.1007/s10825-018-1171-3>`_ and a few others to explore other functionality. We hope to increase the number and usefulness of these examples over time. You can try directly the examples using `MyBinder.org <https://mybinder.org/v2/gh/qpv-research-group/solcore5/deployment>`_.
2. **Check Solcore examples:** This is the fastest way of getting started. These examples include all the scripts used in the main Solcore paper in the `Journal of Computational Electronics (2018) <https://doi.org/10.1007/s10825-018-1171-3>`_ and a few others to explore other functionality. We hope to increase the number and usefulness of these examples over time. You can try the examples directly using `MyBinder.org <https://mybinder.org/v2/gh/qpv-research-group/solcore5/deployment>`_.

3. **Set the location of a SPICE executable and the SMARTS folder:** You will need to do this eventually in order to use those tools::
3. **Set the location of a SPICE executable and the SMARTS folder:** You will need to do this if you want to use those tools::

.. code:: python
Expand Down

0 comments on commit 502e635

Please sign in to comment.