Difference between revisions of "Mac/Windows Requirements"

From OSUPDOCS
Jump to navigation Jump to search
 
(55 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: the 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|installing and using XCode]].
# [[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]]. In fact, if you are happy with the binaries bundled in <b>NairnFEAMOM</b>, you are done. The following requirements are only need if you want to download and build all source code.
# [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]].
# XCode: The best way to compile on MacOS is to use XCode. It is available for download on the Mac App Store. To be able to compile in XCode, you will need to [[Compiling_in_MacOS_X#Compiling_Xerces_on_MacOS_X|install Xerces]] and setup for [[Compiling_in_MacOS_X#Compiling_for_OpenMP|compiling with OpenMP]] to allow parallel code engines. See compiling help for all requirement to be to [[Compiling in MacOS X#Install XCode|install and use XCode]].
# Subversion tools: 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 installed XCode and activated command line tools.
# [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]].
#* [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]].
# [[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://filezilla-project.org/ FileZilla]: A free and useful tool if you need FTP to transfer results between you Mac and servers that might be running the code.


== Windows Requirements ==
== 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:
# [[NairnFEAMPMViz]]. This Windows application is for running and visualizing calculations. It is not included in the project, but can be [[NairnFEAMPMViz|downloaded here]]. In fact, if you are happy with the binaries bundled in <b>NairnFEAMPMViz</b>, you are done. The following requirements are only need if you want to download and build all source code.
#* [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: The [[NairnFEAMPMViz]] contains a Java runtime engine. If you want to general install of Java, you should intall 1.8.0 (a.k.a Java 8) or newer. 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).
# [https://visualstudio.microsoft.com Visual Studio]: Compiling in Windows is done use community version of Visual Studio (it is a very large download). Before compiling in Visual studio, you will need to install the [[Compiling in Windows#Installing Xerces|<tt>xerces</tt> library]] for parsing of <tt>XML</tt> input files.
# [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://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.
# [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.
# [https://notepad-plus-plus.org/ Notepad++]. This application is a powerful text editor with options for plug ins.
# [https://filezilla-project.org/ FileZilla]: A free and useful tool if you need FTP to transfer results between you PC and servers that might be running the code.

Latest revision as of 12:33, 23 April 2024

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. NairnFEAMPM. This application is for running and visualizing calculations on a Mac. It is not included in the project, but can be downloaded here. In fact, if you are happy with the binaries bundled in NairnFEAMOM, you are done. The following requirements are only need if you want to download and build all source code.
  2. XCode: The best way to compile on MacOS is to use XCode. It is available for download on the Mac App Store. To be able to compile in XCode, you will need to install Xerces and setup for compiling with OpenMP to allow parallel code engines. See compiling help for all requirement to be to install and use XCode.
  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. 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.
    • 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.
  5. 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.
    • 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.
    • 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).
  6. TexShop: This recommended software is needed if you want to edit the LaTeX technical notes in OSParticulas.
  7. FileZilla: A free and useful tool if you need FTP to transfer results between you Mac and servers that might be running the code.

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. NairnFEAMPMViz. This Windows application is for running and visualizing calculations. It is not included in the project, but can be downloaded here. In fact, if you are happy with the binaries bundled in NairnFEAMPMViz, you are done. The following requirements are only need if you want to download and build all source code.
    • 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.
    • Java: The NairnFEAMPMViz contains a Java runtime engine. If you want to general install of Java, you should intall 1.8.0 (a.k.a Java 8) or newer. 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).
  2. Visual Studio: Compiling in Windows is done use community version of Visual Studio (it is a very large download). Before compiling in Visual studio, you will need to install the xerces library for parsing of XML input files.
  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. 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.
  6. KLatexFormula. One you have LaTex installed, this utility is nice option for typesetting equations to include in presentations you make about simulation results.
  7. Notepad++. This application is a powerful text editor with options for plug ins.
  8. FileZilla: A free and useful tool if you need FTP to transfer results between you PC and servers that might be running the code.