Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,10 @@ See our ["Tutorials Page"](https://pecanproject.github.io/tutorials.html) that p

### Installation

Complete instructions on how to install PEcAn can be found in the [documentation here](https://pecanproject.github.io/pecan-documentation/develop/pecan-manual-setup.html). To get PEcAn up and running you can use one of three methods:
Complete instructions on how to install PEcAn can be found in the [documentation here](https://pecanproject.github.io/pecan-documentation/develop/pecan-manual-setup.html). To get PEcAn up and running you can use one of the following methods:

1. Run a [Virtual Machine](https://pecanproject.github.io/pecan-documentation/develop/install-vm.html#install-vm). This is recommended for students and new users, and provides a consistent, tested environment for each release.

2. Use [Docker](https://pecanproject.github.io/pecan-documentation/develop/install-docker.html#install-docker). This is recommended, especially for development and production deployment.

3. Install all of the PEcAn R packages on your own Linux or MacOS computer or server. This can be done by [installing from r-universe](https://pecanproject.github.io/pecan-documentation/develop/r-universe.html):
1. Use [Docker](https://pecanproject.github.io/pecan-documentation/develop/install-docker.html#install-docker). This is recommended, especially for development and production deployment.
2. Install all of the PEcAn R packages on your own Linux or MacOS computer or server. This can be done by [installing from r-universe](https://pecanproject.github.io/pecan-documentation/develop/r-universe.html):

```R
# Enable repository from pecanproject
Expand All @@ -46,7 +43,7 @@ options(repos = c(
install.packages('PEcAn.all')
```

This, however, may have limited functionality without also installing other components of PEcAn, in particular [BETYdb](https://pecanproject.github.io/pecan-documentation/develop/osinstall.html#install-bety).
Some functionalities will be limited without also installing the Postgres database ([BETYdb](https://pecanproject.github.io/pecan-documentation/develop/osinstall.html#install-bety)), though we are making steady progress toward removing this dependency.

### Website

Expand Down
41 changes: 0 additions & 41 deletions book_source/02_demos_tutorials_workflows/01_install_pecan.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,54 +2,13 @@

These instructions are provided to document how to install and setup PEcAn. It includes:

- [Virtual machine](#install-vm) (Recommended for students and new users)
- [PEcAn Docker](#install-docker) (Recommended for development and production deployment)
- [Local installation from r-universe](#r-universe) (Recommended for development only)
- [PEcAn OS specific installation](#install-native)

The PEcAn code and necessary infrastructure can be obtained and compiled in different ways.
This set of instructions will help facilitate your path and the steps necessary to move forward to have a fully a functioning PEcAn environment.

## Virtual Machine (VM) {#install-vm}

The PEcAn virtual machine consists of all of PEcAn pre-compiled within a Linux operating system and saved in a "virtual machine" (VM).
Virtual machines allow for running consistent set-ups without worrying about differences between operating systems, library dependencies, compiling the code, etc.

1. **Install VirtualBox** This is the software that runs the virtual machine. You can find the download link and instructions at [https://www.virtualbox.org](https://www.virtualbox.org). *NOTE: On Windows you may see a warning about Logo testing, it is okay to ignore the warning.*

2. **Download the PEcAn VM** You can find the download link at [http://opensource.ncsa.illinois.edu/projects/artifacts.php?key=PECAN](http://opensource.ncsa.illinois.edu/projects/artifacts.php?key=PECAN), under the "**Files**" header. Click the ".ova" file to begin the download. Note that the file is ~7 GB, so this download can take several minutes to hours depending on your connection speed. Also, the VM requires >4 GB of RAM to operate correctly. Please check current usage of RAM and shutdown processes as needed.

3. **Import the VM** Once the download is complete, open VirtualBox. In the VirtualBox menus, go to "File" → "Import Appliance" and locate the downloaded ".ova" file.


For Virtualbox version 5.x: In the Appliance Import Settings, make sure you select "Reinitialize the MAC address of all network cards" (picture below). This is not selected by default and can result in networking issues since multiple machines might claim to have the same network MAC Address.

```{r, echo=FALSE, fig.align='center'}
knitr::include_graphics(rep("figures/pic1.jpg"))
```

For Virtualbox versions starting with 6.0, there is a slightly different interface (see figure). Select "Generate new MAC addresses for all network adapters" from the MAC Address Policy:

```{r, echo=FALSE, fig.align='center'}
knitr::include_graphics(rep("figures/pic1v2.png"))
```

NOTE: If you experience network connection difficulties in the VM with this enabled, try re-importing the VM without this setting selected).

Finally, click "Import" to build the Virtual Machine from its image.

4. **Launch PEcAn** Double click the icon for the PEcAn VM. A terminal window will pop up showing the machine booting up which may take a minute. It is done booting when you get to the `pecan login:` prompt. You do not need to login as the VM behaves like a server that we will be accessing through you web browser. Feel free to minimize the VM window.

* If you _do_ want to login to the VM, the credentials are as follows: `username: carya`, `password: illinois` (after the pecan tree, [_Carya illinoinensis_][pecan-wikipedia]).

5. **Open the PEcAn web interface** With the VM running in the background, open any web browser on the same machine and navigate to `localhost:6480/pecan/` to start the PEcAn workflow. (NOTE: The trailing backslash may be necessary depending on your browser)

6. **Advanced interaction with the VM is mostly done through the command line.** You can perform these manipulations from inside the VM window. However, the VM is also configured for SSH access (username `carya`, hostname `localhost`, port 6422). For instance, to open an interactive shell inside the VM from a terminal on the host machine, use a command like `ssh -l carya -p 6422 localhost` (when prompted, the password is `illinois`, as above).

These steps should be enough to get you started with running models and performing basic analyses with PEcAn.
For advanced details on VM configuration and maintenance, see the [Advanced VM section](#working-with-vm).


## Docker {#install-docker}

This is a short documentation on how to start with Docker and PEcAn.
Expand Down
234 changes: 0 additions & 234 deletions book_source/03_topical_pages/01_advanced_vm.Rmd

This file was deleted.

2 changes: 1 addition & 1 deletion book_source/03_topical_pages/12_troubleshooting-pecan.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Cookies and pecan web pages

You may need to disable cookies specifically for the pecan webserver in your browser. This shouldn't be a problem running from the virtual machine, but your installation of php can include a 'PHPSESSID' that is quite long, and this can overflow the params field of the workflows table, depending on how long your hostname, model name, site name, etc are.
You may need to disable cookies specifically for the pecan webserver in your browser. This is because your installation of php can include a 'PHPSESSID' that is quite long, and this can overflow the params field of the workflows table, depending on how long your hostname, model name, site name, etc are.

## `Warning: mkdir() [function.mkdir]: No such file or directory`

Expand Down
Loading
Loading