Skip to content

Commit

Permalink
Initial 0.5.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
gutow committed Jul 16, 2021
0 parents commit e8dc1fb
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## JPSLInstructor
(aka Jupyter Physical Science Lab Instructor package)

This package installs all of the packages in the
[Jupyter Physical Science lab suite](https://github.com/JupyterPhysSciLab),
their dependencies and the [Algebra_with_SymPy](https://github.com/gutow/Algebra_with_Sympy)
package into the current python environment. The packages can then be used
in a Jupyter notebook to construct assignments. See the overall
documentation and the descriptions of each package for more details.

#### Installation
1. Install python3+ on your system, if you have not. See
[python.org](https://python.org) for instructions.
1. Install a tool for managing and using virtual environments. This
allows you to have multiple independent sets (virtual environments)
of python packages installed. I recommend you use this so
that you can have both an "instructor" and "student" environment for
testing. I personally like using
[pipenv](https://pipenv.pypa.io/en/latest/). You can install it using
the command `$ pip3 --user install pipenv`. See the website for more
information.
1. Once you have the correct python and a virtual environment system,
create a directory for your "Instructor" environment. Navigate into
the directory. Then:
* Create the empty virtual environment `$ pipenv shell`. This will
create the environment, activate it and leave you inside it.
* Still within the environment use pip to install this package
`$ pip install JPSLInstructor`. This will take a while to run. There
are a lot of packages to download and install.
1. To exit the virtual environment just type "exit" on the command line
`$ exit`.
1. To enter the virtual environment: first make sure you are in the proper
directory; then issue the command `$ pipenv shell`.
1. To update you must be in the virtual environment. Use
`$ pip install -U JPSLInstructor`.
34 changes: 34 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import setuptools

with open("README.md", "r") as f:
long_description = f.read()

setuptools.setup(
name="JPSLInstructor",
version="0.5.0",
description="Install all modules for Jupyter Physical Science Lab",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/JupyterPhysSciLab/JPSLInstructor",
author="Jonathan Gutow",
author_email="[email protected]",
license="GPL-3.0+",
packages=setuptools.find_packages(),
include_package_data=True,
install_requires=[
# 'python>=3.6',
'jupyter>=1.0.0',
'jupyter-instructortools>=0.5.2',
'jupyterPiDAQ>=0.7.1',
'Algebra_with_SymPy>=0.9.0',
],
classifiers=[
'Development Status :: 4 - Beta',
'Intended Audience :: Developers',
'Intended Audience :: Education',
'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)',
'Programming Language :: Python :: 3',
'Programming Language :: JavaScript',
'Operating System :: OS Independent'
]
)

0 comments on commit e8dc1fb

Please sign in to comment.