Difference between revisions of "Mac/Windows Requirements"

From OSUPDOCS
Jump to navigation Jump to search
(22 intermediate revisions by the same user not shown)
Line 3: Line 3:
== MacOS Requirements ==
== MacOS Requirements ==


The following installations are recommended when using MacOS
The following installations are recommended (or required) when using MacOS


# XCode:Tthe best way to compile on MacOS is to use XCode. It is available for download on the Mac App Store. See compiling help for more details on [[Compiling in MacOS X#Install XCode|installing and using XCode]].
# XCode:Tthe best way to compile on MacOS is to use XCode. It is available for download on the Mac App Store. See compiling help for more details on [[Compiling in MacOS X#Install XCode|installing and using XCode]].
# <tt>clang-mp</tt>: Compling on a mac requires the <tt>clang-mp</tt> compiler. It is a [[Compiling in MacOS X#Install Clang-mp|separate install]] because it does not come with XCode.
# [http://xml.apache.org/xerces-c/index.html Xerces]: Running and compiling this project requires the <tt>xerces</tt> library for parsing of <tt>XML</tt> files. Installation instructions on give in [[Compile the Code Engines]].
# <tt>clang-mp</tt>: Compling on a Mac requires the <tt>clang-mp</tt> compiler. It is a [[Compiling in MacOS X#Install Clang-mp|separate install]] because it does not come with XCode.
# [https://github.com/nairnj/nairn-mpm-fea Github]: The <tt>nairn-mpm-fea</tt> project is hosted on [https://github.com/nairnj/nairn-mpm-fea Github]. Please see [https://github.com/ <tt>github.com</tt>] for system-specific details and for installation of any needed tools. The software is used to clone the entire [[Download Source Code|<tt>nairn-mpm-fea</tt> project]].
# [https://github.com/nairnj/nairn-mpm-fea Github]: The <tt>nairn-mpm-fea</tt> project is hosted on [https://github.com/nairnj/nairn-mpm-fea Github]. Please see [https://github.com/ <tt>github.com</tt>] for system-specific details and for installation of any needed tools. The software is used to clone the entire [[Download Source Code|<tt>nairn-mpm-fea</tt> project]].
# Subversion: If you are working on [[OSParticulas]], that project is hosted on a private server and checkout is done using <tt>svn</tt> (or Subversion). Prior to MacOS Big Sur, <tt>svn</tt> was automatically installed when you [[Compiling in MacOS X#Install XCode|install XCode and activate command line tools]]. Although Apple deleted <tt>svn</tt> in Big Sur, it can be [[OSParticulas#Installing svn in MacOS|installed separately]].
# Subversion: If you are working on [[OSParticulas]], that project is hosted on a private server and checkout is done using <tt>svn</tt> (or Subversion). Prior to MacOS Big Sur, <tt>svn</tt> was automatically installed when you [[Compiling in MacOS X#Install XCode|install XCode and activate command line tools]]. Although Apple deleted <tt>svn</tt> in Big Sur, it can be [[OSParticulas#Installing svn in MacOS|installed separately]].
# [https://www.versionsapp.com/ Versions]: This software provides a visual interface to using <tt>svn</tt> while working with [[OSParticulas]]. If fact, it can do most <tt>svn</tt> tasks without even needing to install Subversion in Big Sur (or newer). If you need the command-line options it cannot handle, you may need to [[OSParticulas#Installing svn in MacOS|install <tt>svn</tt> separately]].
# [https://www.versionsapp.com/ Versions]: This software provides a visual interface to using <tt>svn</tt> while working with [[OSParticulas]]. If fact, it can do most <tt>svn</tt> tasks without even needing to install Subversion in Big Sur (or newer). If you need the command-line options it cannot handle, you may need to [[OSParticulas#Installing svn in MacOS|install <tt>svn</tt> separately]].
# [[NairnFEAMPM]]. This application is for running and visualizing calculations on a Mac. It is not included in the project, but can be [[NairnFEAMPM|downloaded here]].
# [[NairnFEAMPM]]. This application is for running and visualizing calculations on a Mac. It is not included in the project, but can be [[NairnFEAMPM|downloaded here]].
# [[NairnFEAMPMViz]]. An alternative to [[NairnFEAMPM]] is to use the Java app [[NairnFEAMPMViz]]. The only reason to use this option on a Mac is because the project has complete source code for [[NairnFEAMPMViz]]. You can work with source code to add new features if desired. A good option for [[NairnFEAMPMViz#Compiling the NairnFEAMPMViz Java Application compiling your changes]] is to use [https://www.eclipse.org Eclipse]. You will alops need to have Java 1.8.0 (a.k.a Java 8) or new installed.
# [[NairnFEAMPMViz]]. An alternative to [[NairnFEAMPM]] is to use the Java app [[NairnFEAMPMViz]]. The only reason to use this option on a Mac is because the project has complete source code for [[NairnFEAMPMViz]]. You can work with source code to add new features if desired.
# [https://www.eclipse.org Eclipse]. The project has complete source code for [[NairnFEAMPMViz]]. You can work with source code to add new features if desired. A good option for [[NairnFEAMPMViz#Compiling the NairnFEAMPMViz Java Application|compiling your changes]] is to use [https://www.eclipse.org Eclipse].
# Java: You can run Java applications within [https://www.eclipse.org Eclipse],  but if you want to be able to run Java applications on their own, you will need a separate Java installation. Since 2019, getting Java from Oracle has been unclear and they want you to pay $300 for license. Furthermore, they do not appear to provide Java for the Mac M1 chips (ARM architecture). A easy and free option is to install Java from [https://www.azul.com/downloads/zulu-community/ Azul]. You can get many versions and pick the one right for your processor. For now, [[NairnFEAMPMViz]] is written using Java 8 (a.k.a 1.8), but it should run in any newer version. If you are only running Java applications, you only need install the run-time environment (JRE).
# [https://pages.uoregon.edu/koch/texshop/ TexShop]: This recommended software is needed if you want to edit the LaTeX technical notes in [[OSParticulas]].
# [https://pages.uoregon.edu/koch/texshop/ TexShop]: This recommended software is needed if you want to edit the LaTeX technical notes in [[OSParticulas]].


== Windows Requirements ==
== Windows Requirements ==


In Windows, you can try on calculations by downloading [[NairnFEAMPMViz]] (although you will also need to have Java 1.8.0 (a.k.a Java 8) or new installed. If you decide you want to get further into the project, such as adding you own features or revising the visualization tools, you will need to download source code. When working with project source code in Windows, the following installations are recommended:
In Windows, you can try out calculations by downloading just [[NairnFEAMPMViz]]. If you decide you want to get further into the project, such as adding your own features or revising the visualization tools, you will need to download source code. When working with project source code in Windows, the following installations are recommended:


# Visual Studio
# [https://visualstudio.microsoft.com Visual Studio]: Compiling in Windows is done use community version of Visual Studio (it is a very large download).
# [http://xml.apache.org/xerces-c/index.html Xerces]: Running and compiling this project requires the <tt>xerces</tt> library for parsing of <tt>XML</tt> files. Installation instructions are given in help on [[Compiling in Windows]].
# [https://github.com/nairnj/nairn-mpm-fea Github]: The <tt>nairn-mpm-fea</tt> project is hosted on [https://github.com/nairnj/nairn-mpm-fea Github]. Please see [https://github.com/ <tt>github.com</tt>] for system-specific details and for installation of any needed tools. The software is used to clone the entire [[Download Source Code|<tt>nairn-mpm-fea</tt> project]].
# [https://github.com/nairnj/nairn-mpm-fea Github]: The <tt>nairn-mpm-fea</tt> project is hosted on [https://github.com/nairnj/nairn-mpm-fea Github]. Please see [https://github.com/ <tt>github.com</tt>] for system-specific details and for installation of any needed tools. The software is used to clone the entire [[Download Source Code|<tt>nairn-mpm-fea</tt> project]].
# [https://tortoisesvn.net/ TortoiseSVN]: If you are working on [[OSParticulas]], that project is hosted on a private server and checkout is done using <tt>svn</tt> (or Subversion). A good option for Windows is [https://tortoisesvn.net/ TortoiseSVN].
# [https://tortoisesvn.net/ TortoiseSVN]: If you are working on [[OSParticulas]], that project is hosted on a private server and checkout is done using <tt>svn</tt> (or Subversion). A good option for Windows is [https://tortoisesvn.net/ TortoiseSVN].
# [[NairnFEAMPMViz]]. This application is for running and visualizing calculations on a Mac. It is not included in the project, but can be [[NairnFEAMPM|downloaded here]]. To use this application in Windows, you will need to have Java 1.8.0 (a.k.a Java 8) or newer installed.
# [[NairnFEAMPMViz]]: This application is for running and visualizing calculations on a Mac. The source code and a jar file are in [[Download Source Code|project download]]. Alternatively, you can run calculations without even downloading an compiling all tools by [[NairnFEAMPM|downloading a self-contained package here]].
# [https://www.eclipse.org Eclipse]. The project has complete source code for [[NairnFEAMPMViz]]. You can work with source code to add new features if desired. A good option for [[NairnFEAMPMViz#Compiling the NairnFEAMPMViz Java Application compiling your changes]] is to use [https://www.eclipse.org Eclipse].
# Java: You will need to have Java 1.8.0 (a.k.a Java 8) or newer installed to run [[NairnFEAMPMViz]]. Since 2019, getting Java from Oracle has been unclear and they want you to pay $300 for license. A easy and free option is to install Java from [https://www.azul.com/downloads/zulu-community/ Azul]. You can get many versions and pick the one right for your processor. For now, [[NairnFEAMPMViz]] is written using Java 8 (aka 1.8), but it should run in any newer version. If you are only running Java applications, you only need to install the run-time environment (JRE).
# Texmaker
# [https://www.eclipse.org Eclipse]. The project has complete source code for [[NairnFEAMPMViz]]. You can work with source code to add new features if desired. A good option for [[NairnFEAMPMViz#Compiling the NairnFEAMPMViz Java Application|compiling your changes]] is to use [https://www.eclipse.org Eclipse].
# MikTex 2.9
# [https://www.xm1math.net/texmaker/ Texmaker]. This recommended software is needed if you want to edit the LaTeX technical notes in [[OSParticulas]]. Texmaker needs a separate installation of LaTex and [https://miktex.org/ MikTeX] is a good option.
# KLatexFormula
# [https://klatexformula.sourceforge.io/ KLatexFormula]. One you have LaTex installed, this utility is nice option for typesetting equations to include in presentations you make about simulation results.
# Notepad++ and some plug ins
# [https://notepad-plus-plus.org/ Notepad++]. This application is a powerful text editor with options for plug ins.

Revision as of 16:30, 14 July 2021

Use of this project on Mac and Windows requires more than just a basic computer. This section list some other software that is essential, or recommended, for using this software.

MacOS Requirements

The following installations are recommended (or required) when using MacOS

  1. XCode:Tthe best way to compile on MacOS is to use XCode. It is available for download on the Mac App Store. See compiling help for more details on installing and using XCode.
  2. Xerces: Running and compiling this project requires the xerces library for parsing of XML files. Installation instructions on give in Compile the Code Engines.
  3. clang-mp: Compling on a Mac requires the clang-mp compiler. It is a separate install because it does not come with XCode.
  4. Github: The nairn-mpm-fea project is hosted on Github. Please see github.com for system-specific details and for installation of any needed tools. The software is used to clone the entire nairn-mpm-fea project.
  5. Subversion: If you are working on OSParticulas, that project is hosted on a private server and checkout is done using svn (or Subversion). Prior to MacOS Big Sur, svn was automatically installed when you install XCode and activate command line tools. Although Apple deleted svn in Big Sur, it can be installed separately.
  6. Versions: This software provides a visual interface to using svn while working with OSParticulas. If fact, it can do most svn tasks without even needing to install Subversion in Big Sur (or newer). If you need the command-line options it cannot handle, you may need to install svn separately.
  7. NairnFEAMPM. This application is for running and visualizing calculations on a Mac. It is not included in the project, but can be downloaded here.
  8. NairnFEAMPMViz. An alternative to NairnFEAMPM is to use the Java app NairnFEAMPMViz. The only reason to use this option on a Mac is because the project has complete source code for NairnFEAMPMViz. You can work with source code to add new features if desired.
  9. Eclipse. The project has complete source code for NairnFEAMPMViz. You can work with source code to add new features if desired. A good option for compiling your changes is to use Eclipse.
  10. Java: You can run Java applications within Eclipse, but if you want to be able to run Java applications on their own, you will need a separate Java installation. Since 2019, getting Java from Oracle has been unclear and they want you to pay $300 for license. Furthermore, they do not appear to provide Java for the Mac M1 chips (ARM architecture). A easy and free option is to install Java from Azul. You can get many versions and pick the one right for your processor. For now, NairnFEAMPMViz is written using Java 8 (a.k.a 1.8), but it should run in any newer version. If you are only running Java applications, you only need install the run-time environment (JRE).
  11. TexShop: This recommended software is needed if you want to edit the LaTeX technical notes in OSParticulas.

Windows Requirements

In Windows, you can try out calculations by downloading just NairnFEAMPMViz. If you decide you want to get further into the project, such as adding your own features or revising the visualization tools, you will need to download source code. When working with project source code in Windows, the following installations are recommended:

  1. Visual Studio: Compiling in Windows is done use community version of Visual Studio (it is a very large download).
  2. Xerces: Running and compiling this project requires the xerces library for parsing of XML files. Installation instructions are given in help on Compiling in Windows.
  3. Github: The nairn-mpm-fea project is hosted on Github. Please see github.com for system-specific details and for installation of any needed tools. The software is used to clone the entire nairn-mpm-fea project.
  4. TortoiseSVN: If you are working on OSParticulas, that project is hosted on a private server and checkout is done using svn (or Subversion). A good option for Windows is TortoiseSVN.
  5. NairnFEAMPMViz: This application is for running and visualizing calculations on a Mac. The source code and a jar file are in project download. Alternatively, you can run calculations without even downloading an compiling all tools by downloading a self-contained package here.
  6. Java: You will need to have Java 1.8.0 (a.k.a Java 8) or newer installed to run NairnFEAMPMViz. Since 2019, getting Java from Oracle has been unclear and they want you to pay $300 for license. A easy and free option is to install Java from Azul. You can get many versions and pick the one right for your processor. For now, NairnFEAMPMViz is written using Java 8 (aka 1.8), but it should run in any newer version. If you are only running Java applications, you only need to install the run-time environment (JRE).
  7. Eclipse. The project has complete source code for NairnFEAMPMViz. You can work with source code to add new features if desired. A good option for compiling your changes is to use Eclipse.
  8. Texmaker. This recommended software is needed if you want to edit the LaTeX technical notes in OSParticulas. Texmaker needs a separate installation of LaTex and MikTeX is a good option.
  9. KLatexFormula. One you have LaTex installed, this utility is nice option for typesetting equations to include in presentations you make about simulation results.
  10. Notepad++. This application is a powerful text editor with options for plug ins.