Skip to content

Commit

Permalink
Merge pull request #1 from DerekRoy/DerekRoy-patch-1
Browse files Browse the repository at this point in the history 
Update to the Read.Md file
  • Loading branch information
@DerekRoy
DerekRoy authored Nov 7, 2018
2 parents b8b7b56 + 9853cc3 commit 41c1543
Showing 1 changed file with 30 additions and 30 deletions.
60 changes: 30 additions & 30 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,69 +17,69 @@
An extensible environment for interactive and reproducible computing, based on the
Jupyter Notebook and Architecture. [Currently ready for users.](https://blog.jupyter.org/jupyterlab-is-ready-for-users-5a6f039b8906)

[JupyterLab](http://jupyterlab.readthedocs.io/en/stable/) is the next-generation user interface for [Project Jupyter](https://jupyter.org). It offers
[JupyterLab](http://jupyterlab.readthedocs.io/en/stable/) is the next-generation user interface for [Project Jupyter](https://jupyter.org)offering
all the familiar building blocks of the classic Jupyter Notebook (notebook,
terminal, text editor, file browser, rich outputs, etc.) in a flexible and
powerful user interface.
Eventually, JupyterLab will replace the classic Jupyter Notebook.
JupyterLab will eventually replace the classic Jupyter Notebook.

JupyterLab can be extended using extensions that are [npm](https://www.npmjs.com/) packages
and use our public APIs. You can search for the GitHub topic [jupyterlab-extension](https://github.com/topics/jupyterlab-extension) to find extensions. To learn more about extensions, see our [user documentation](https://jupyterlab.readthedocs.io/en/latest/user/extensions.html).
JupyterLab can be extended using [npm](https://www.npmjs.com/) packages
and our public APIs. To find extensions search for the GitHub topic [jupyterlab-extension](https://github.com/topics/jupyterlab-extension). To learn more about extensions, see the [user documentation](https://jupyterlab.readthedocs.io/en/latest/user/extensions.html).

The current JupyterLab releases are suitable for general
usage. For JupyterLab extension developers, the extension APIs will continue to
evolve.
usage, and the extension APIs will continue to
evolve for JupyterLab extension developers.

Read the latest version of our documentation on [ReadTheDocs](http://jupyterlab.readthedocs.io/en/latest/).
Read the latest version's documentation on [ReadTheDocs](http://jupyterlab.readthedocs.io/en/latest/).

---

## Getting started

### Installation

You can [install](http://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html) JupyterLab using `conda`, `pip`, or `pipenv`. We recommend using conda if you do not have a preference.
[install](http://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html) JupyterLab using `conda`, `pip`, or `pipenv`. Conda is recommended if you have no installation preference.

Instructions on how to install the project from the git sources are available in our [contributor documentation](CONTRIBUTING.md).
Project instalation instructions from the git sources are available in the [contributor documentation](CONTRIBUTING.md).

#### conda

Conda is an open source package management system and environment management system that runs on Windows, macOS and Linux. It can package and distribute software for any language, and by default uses the Anaconda repository managed by Anaconda, Inc. If you wish to use conda and do not have it, [see the conda installation instructions](https://conda.io/docs/user-guide/install/index.html).
Conda is an open source package management system and environment management system that runs on Windows, macOS, and Linux. Conda packages and distributes software for any language, and by default uses the Anaconda repository managed by Anaconda Inc. To install conda please [see the conda installation instructions](https://conda.io/docs/user-guide/install/index.html).

If you use [`conda`](https://anaconda.org/conda-forge/jupyterlab), you can install as:
Use [`conda`](https://anaconda.org/conda-forge/jupyterlab), and install with the command:

```bash
conda install -c conda-forge jupyterlab
```

#### pip

pip is a package management system for installing and updating Python packages. pip comes with Python, so you get pip simply by installing Python. On Ubuntu and Fedora Linux, you can simply use your system package manager to install the `python3-pip` package. [_The Hitchhiker's Guide to Python_ provides some guidance on how to install Python on your system if it isn't already](https://docs.python-guide.org/starting/installation/); you can also [install Python directly from python.org](https://www.python.org/getit/). You might want to [upgrade pip](https://pip.pypa.io/en/stable/installing/) before using it to install other programs.
pip is a package management system for installing and updating Python packages, and comes with any Python installation. On Ubuntu and Fedora Linux, use the system package manager to install the `python3-pip` package. [_The Hitchhiker's Guide to Python_provides guidance on how to install Python](https://docs.python-guide.org/starting/installation/); Another option is to [install Python directly from python.org](https://www.python.org/getit/). We suggest you [upgrade pip](https://pip.pypa.io/en/stable/installing/) before using it to install other programs.

JupyterLab requires Python 3.5 or higher.

1. If you are using Windows with Python version 3.5 or higher, use the [Python Launcher for Windows](https://docs.python.org/3/using/windows.html?highlight=shebang#python-launcher-for-windows) to use `pip` with Python version 3:
1. When using Windows with Python version 3.5 or higher, use the [Python Launcher for Windows](https://docs.python.org/3/using/windows.html?highlight=shebang#python-launcher-for-windows) to use `pip` with Python version 3:
```bash
py -3 -m pip install jupyterlab
```
2. If your system has a `python3` command (standard on Unix-like systems), install with:
2. If the system has a `python3` command (standard on Unix-like systems), install with the comand:
```bash
python3 -m pip install jupyterlab
```
3. You can also just use the `python` command directly, but this will use the _current_ version of Python in your environment (which may be version 2 or version 3 of Python if you have both installed):
3. Using the `python` command directly is another option, but this will use the _current_ version of Python (which may be Python version 2 or version 3 if both are installed):
```bash
python -m pip install jupyterlab
```

Some systems have a `pip3` command that has the same effect as `python3 -m pip` and/or a `pip` command that has the same effect as `python -m pip`.
Some systems have a `pip3` command that has the same effect as `python3 -m pip` and/or a `pip` command that behaves the same as `python -m pip`.

If you add `--user` after `pip install` you will install the files to a local user install directory (typically `~/.local/` or `%APPDATA%\Python` on Windows) instead of the system-wide directory. This can be helpful, especially if you are not allowed to write to the system-wide directory. However, if you do this, you must add the user-level `bin` directory to your `PATH` environment variable in order to launch `jupyter lab`.
Adding `--user` after `pip install` will install the files to a local user install directory (typically `~/.local/` or `%APPDATA%\Python` on Windows) instead of the system-wide directory. This can be helpful, especially if writing to the system-wide directory is not permitted. However, the user-level `bin` directory must be added to the `PATH` environment variable in order to launch `jupyter lab`.

#### pipenv

`Pipenv` is intended to provide users and developers of applications with an easy method to setup a working environment. You must have Python installed first. See the [pipenv installation documentation](https://docs.pipenv.org/install) if you wish to use it but do not have it installed.
`Pipenv` provides users and developers of applications with an easy method to setup a working environment, however Python must be installed first. See the [pipenv installation documentation](https://docs.pipenv.org/install) to use Pipenv if it is not installed.

If you use `pipenv`, you can install it as:
`pipenv`, can be installed as:

```bash
pipenv install jupyterlab
Expand All @@ -93,7 +93,7 @@ pipenv install git+git://github.com/jupyterlab/jupyterlab.git#egg=jupyterlab
pipenv shell
```

When using `pipenv`, in order to launch `jupyter lab`, you must activate the project's virtualenv. For example, in the directory where `pipenv`'s `Pipfile` and `Pipfile.lock` live (i.e., where you ran the above commands):
When using `pipenv`, in order to launch `jupyter lab`, activate the project's virtualenv. For example, in the directory where `pipenv`'s `Pipfile` and `Pipfile.lock` live (i.e., where the above commands were run):

```bash
pipenv shell
Expand All @@ -102,7 +102,7 @@ jupyter lab

#### Installing with Previous Versions of Jupyter Notebook

If you are using a version of Jupyter Notebook earlier than 5.3, then you must also run the following command
When using a version of Jupyter Notebook earlier than 5.3, the following command must be run
after installation to enable the JupyterLab server extension:

```bash
Expand All @@ -117,11 +117,11 @@ Start up JupyterLab using:
jupyter lab
```

JupyterLab will open automatically in your browser. See our [documentation](http://jupyterlab.readthedocs.io/en/stable/getting_started/starting.html) for additional details.
JupyterLab will open automatically in the browser. See the [documentation](http://jupyterlab.readthedocs.io/en/stable/getting_started/starting.html) for additional details.

### Prerequisites and Supported Browsers

Jupyter notebook version 4.3 or later. To check the notebook version:
Jupyter notebook version 4.3 or later is required. To check the notebook version run the command:

```bash
jupyter notebook --version
Expand All @@ -141,22 +141,22 @@ See our [documentation](http://jupyterlab.readthedocs.io/en/latest/getting_start

### Contributing

If you would like to contribute to the project, please read our [contributor documentation](CONTRIBUTING.md).
To contribute to the project, please read the [contributor documentation](CONTRIBUTING.md).

JupyterLab follows the Jupyter [Community Guides](https://jupyter.readthedocs.io/en/latest/community/content-community.html).

### Extending JupyterLab

To start developing your own extension, see our [developers documentation](https://jupyterlab.readthedocs.io/en/latest/developer/extension_dev.html) and [API docs](http://jupyterlab.github.io/jupyterlab/index.html).
To start developing extension, see the [developers documentation](https://jupyterlab.readthedocs.io/en/latest/developer/extension_dev.html) and [API docs](http://jupyterlab.github.io/jupyterlab/index.html).

### License

We use a shared copyright model that enables all contributors to maintain the
A shared copyright model enables all contributors to maintain the
copyright on their contributions. All code is licensed under the terms of the revised [BSD license](https://github.com/jupyterlab/jupyterlab/blob/master/LICENSE).

### Team

JupyterLab is part of [Project Jupyter](http://jupyter.org/) and is developed by an open community of contributors. Our maintainer team is accompanied by a much larger group of contributors to JupyterLab and Project Jupyter as a whole.
JupyterLab is part of [Project Jupyter](http://jupyter.org/) and is developed by an open community. The maintenance team is assisted by a much larger group of contributors to JupyterLab and Project Jupyter as a whole.

JupyterLab's current maintainers are listed in alphabetical order, with affiliation, and main areas of contribution:
Expand All @@ -179,12 +179,12 @@ Maintainer emeritus:
- Cameron Oelsen, Cal Poly (UI/UX design).
This list is provided to help provide context about who we are and how our team functions.
If you would like to be listed, please submit a pull request with your information.
This list is provided to give the reader context on who we are and how our team functions.
To be listed, please submit a pull request with your information.
---
## Getting help
We encourage you to ask questions on the [mailing list](https://groups.google.com/forum/#!forum/jupyter),
and you may participate in development discussions or get live help on [Gitter](https://gitter.im/jupyterlab/jupyterlab). Please use our [issues page](https://github.com/jupyterlab/jupyterlab/issues) to provide feedback or submit a bug report.
and participate in development discussions or get live help on [Gitter](https://gitter.im/jupyterlab/jupyterlab). Please use the [issues page](https://github.com/jupyterlab/jupyterlab/issues) to provide feedback or submit a bug report.

0 comments on commit 41c1543

Please sign in to comment.