Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add update instructions for macos #3446

Merged
merged 4 commits into from
Jan 16, 2024
Merged

Add update instructions for macos #3446

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b7197e9
Remove os tag
reyery Jan 16, 2024
cf47daa
Add macos update instructions
reyery Jan 16, 2024
298d488
Add macos update instructions
reyery Jan 16, 2024
18e8a72
Update installation-on-macos.rst
ShiZhongming Jan 16, 2024
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
25 changes: 22 additions & 3 deletions docs/installation/installation-on-macos.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,20 @@ Prerequisites

Installation
~~~~~~~~~~~~
Fresh installation
_________________________
.. note:: (*Experimental*) We have a script that can automate the process below. Just open a Terminal console and enter ``/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/architecture-building-systems/CityEnergyAnalyst/master/install/mac_installation.sh)"`` Continue on the next section to find out how to interact with CEA.
#. Open GitHub Desktop from the start menu.
#. Clone the CEA repository with the following URL: https://github.com/architecture-building-systems/CityEnergyAnalyst
#. Clone the CEA GUI repository with the following URL: https://github.com/architecture-building-systems/CityEnergyAnalyst-GUI
#. Install CEA backend:
#. Open a Terminal console
#. Type ``cd Documents/GitHub/CityEnergyAnalyst`` and press ENTER.
#. Type ``CONDA_SUBDIR=osx-64 micromamba env create -f environment.yml`` and press ENTER.
#. Type ``cd ~/Documents/GitHub/CityEnergyAnalyst`` and press ENTER.
#. Type ``micromamba env create -f environment.yml`` and press ENTER.
#. Type ``mircomamba activate cea`` and press ENTER.
#. Type ``pip install -e .`` and press ENTER *(mind the dot '.'!)*.
#. Build the CEA dashboard:
#. Type ``cd ..`` and press ENTER, then type ``cd CityEnergyAnalyst-GUI`` and press ENTER.
#. Type ``cd ~/Documents/GitHub/CityEnergyAnalyst-GUI`` and press ENTER.
#. Install Yarn by typing ``brew install yarn`` and press ENTER.
#. Type ``yarn`` and press ENTER.
#. Type ``yarn package`` and press ENTER.
Expand All @@ -41,6 +43,23 @@ Installation
* If you are running the *Building Solar radiation* tool using the dashboard, make sure the parameter *daysim-bin-directory* (under *Advanced*) points to the correct Daysim binary folder (by default, this should be ``/Users/your_name/Documents/GitHub/CityEnergyAnalyst/setup/Dependencies/Daysim/mac``).
* If you are using the command line interface or Pycharm, you will need to modify the same parameter (i.e., ``config.radiation.daysim_bin_directory``) in the config file (usually located in ``/Users/your_name/cea.config``, where *your_name* represents your user name on your Mac).

Update existing installation
_________________________
These steps would only work if your current installation is installed using the steps above.

#. Update CEA backend:
#. Open a Terminal console
#. Type ``cd ~/Documents/GitHub/CityEnergyAnalyst`` and press ENTER.
#. Type ``git pull`` and press ENTER.
#. Type ``mircomamba activate cea`` and press ENTER.
#. Type ``micromamba update -f environment.yml`` and press ENTER.
#. Update the CEA Dashboard:
#. Type ``cd ~/Documents/GitHub/CityEnergyAnalyst-GUI`` and press ENTER.
#. Type ``git pull`` and press ENTER.
#. Type ``yarn`` and press ENTER.
#. Type ``yarn package`` and press ENTER.
#. You will find the new CEA dashboard in the folder ``/Users/your_name/Documents/GitHub/CityEnergyAnalyst-GUI/out/CityEnergyAnalyst-GUI-darwin-*``

Interfaces
~~~~~~~~~~

Expand Down
Loading