Merge pull request #16 from easifem/macos-dev

Macos dev

Author: vickysharma0812

.marksman.toml

@@ -0,0 +1,52 @@
+# This file lists all configuration options with their default values.
+# You do not need to duplicate all the values in your own user or project config.
+# Only override what is needed.
+
+[core]
+markdown.file_extensions = ["md", "markdown", "mdx", "qmd"]
+# Enable GitLab Flavored Markdown heading ID disambiguation method described
+# in https://docs.gitlab.com/ee/user/markdown.html#heading-ids-and-links.
+# This enables multiple headings with equal IDs to be deterministically
+# referenced by links and impacts ID generation in "Table of Contents"
+# code action.
+markdown.glfm_heading_ids.enable = true
+# Configures text sync protocol between the editor (LSP client)
+# and Marksman (LSP server).
+# Can be either 'full' or `incremental`:
+# * full: the whole copy of a document is sent by the editor
+#   on every update,
+# * incremental: only the changed parts are sent by
+#   the editor. This will result in less trafic between
+#   the editor and Marksman, but the overall performance
+#   impact is marginal.
+# Defaults to `full` because the editors have bugs in incremental
+# sync which result in slightly correpted state and are really hard
+# to diagnose.
+text_sync = "full"
+# When set to true, level 1 headings will be treated as document titles
+# (this includes an assumption of having a single title in the document).
+# Setting this to false automatically changes the default wiki link
+# completion style to a file-based one.
+title_from_heading = true
+# Use incremental resolution of project-wide references.
+# This is much more efficient but is currently experimental
+incremental_references = false
+# For debugging only! Enables extra validation checks around
+# incremental state updates. SIGNIFICANTLY IMPACTS PERFORMANCE
+paranoid = false
+
+[code_action]
+# Enable/disable "Table of Contents" code action
+toc.enable = true
+
+# Enable/disable "Create missing linked file" code action
+create_missing_file.enable = true
+
+[completion]
+# The maximum number of candidates returned for a completion
+candidates = 50
+# The style of wiki links completion.
+# Other values include:
+# * "file-stem" to complete using file name without an extension,
+# * "file-path-stem" same as above but using file path.
+wiki.style = "title-slug"

.yarnrc.yml

@@ -0,0 +1 @@
+ignoreEngines: true

CODE_OF_CONDUCT.md

@@ -1,3 +1,3 @@
 # Code of Conduct
 
-All Dyte repos are governed by our Community Participation Guidelines, available at: https://dyte.notion.site/dyte/Dyte-Community-Participation-Guidelines-CPG-4b3af58fdf3545c2a3065773a9154728
+TODO

CONTRIBUTING.md

@@ -5,10 +5,7 @@
 1. Make your changes, and make sure the site still builds.
 1. Push to your fork and [submit a pull request][compare] from your branch to `master`
 1. Pat yourself on the back and wait for your pull request to be reviewed.
-1. *Here are a few things you have to do:*
+1. _Here are a few things you have to do:_
    - Write a good commit message.
    - Follow the style guide where possible.
    - Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
-
-[fork]: https://github.com/YoussefRaafatNasry/portfolYOU/fork
-[compare]: https://github.com/YoussefRaafatNasry/portfolYOU/compare

README.md

@@ -54,7 +54,7 @@ Our website can be found at `https://easifem.github.io/`, but we want to use cus
 
 We will use `deploy` command that helps you deploy your site from the source branch to the deployment branch in one command: clone, build, and commit.
 
-First we need to configure our project by modyfing `docusaurus.config.js` file. We need to set the 
+First we need to configure our project by modyfing `docusaurus.config.js` file. We need to set the
 
 - `organizationName`, The GitHub user or organization name.
 - `projectName`, The name of the deployment repository.
@@ -63,9 +63,9 @@ First we need to configure our project by modyfing `docusaurus.config.js` file.
 In this repository we have set the following parameters in `docusaurus.config.js` file:
 
 ```js
-  organizationName: "easifem",
-  projectName: "easifem.github.io",
-  deploymentBranch: "gh-pages",
+organizationName: "easifem",
+projectName: "easifem.github.io",
+deploymentBranch: "gh-pages",
 ```
 
 Note that GitHub Pages adds a trailing slash to Docusaurus URLs by default. Therefore, we have set `trailingSlash` to `false` in `docusaurus.config.js` file. This is important for the website to work properly.

babel.config.js

@@ -1,5 +1,5 @@
 /* eslint-disable */
 
 module.exports = {
-  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+  presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
 };

cspell.json

@@ -21,4 +21,4 @@
     "waitlisted",
     "htmlui"
   ]
-}
+}

docs/about/SystemRequirements.md

@@ -11,25 +11,24 @@ import simpleGraph from '!!raw-loader!/img/drawio/easifem-system-requirements.dr
 
 <Drawio content={simpleGraph} page={1} />
 
-| Component | Version | Latest tested version | Comment |
-|:--- | :---: | :---: | :--- |
-| **Gfortran**| >=9.0 | 12.0  | GNU Fortran compiler |
-| **GCC**| >=9.0 | 12.0 | GNU-compiler collection|
-| **OpenMP**| >= 4.5 |  | Multithread shared memory parallelisation|
-| **Curl**| >=7.87 | 7.87 | A command-line utility for transferring data from or to a remote server|
-| **Git**| >=2.34 | 2.34.1 | A version control system and command-line utility for downloading packages from GitHub |
-| **Cmake** | >=3.19 | 3.22.4 | Cross-platform family of tools designed to build, test and package software |
-| **Ninja-build** | >=1.10 | 1.11.0 | Build system |
-| **Python3** | >=3.7 | 3.11.0 | Scripting language |
-| **Pip** | >=20 | 23.1.0 | Command line tool for downloading python packages |
-| **LAPACK** | >=3.11.0 | 3.11.0 | Linear algebra package |
-| **OpenBlas** | >= 0.3.20| 0.3.30 | Optimize BLAS library |
-| **HDF5** | >=1.10  | 1.10.7 | High-performance data software-library and file-format |
-| **PlPlot** | >=5.15.0 | 5.15.0 | Cross-platform, scientific graphics plotting library |
-| **Boost** | | | |
-| **Gnuplot** | >=5.0 | 5.4 | Portable command-line driven graphing utility |
-| **Doxygen** | >=1.9.1 | 1.9.1 | documentation generation |
-| **GTK-4** |  | | n |
+| Component       |  Version  | Latest tested version | Comment                                                                                |
+| :-------------- | :-------: | :-------------------: | :------------------------------------------------------------------------------------- |
+| **Gfortran**    |   >=9.0   |         12.0          | GNU Fortran compiler                                                                   |
+| **GCC**         |   >=9.0   |         12.0          | GNU-compiler collection                                                                |
+| **OpenMP**      |  >= 4.5   |                       | Multithread shared memory parallelisation                                              |
+| **Curl**        |  >=7.87   |         7.87          | A command-line utility for transferring data from or to a remote server                |
+| **Git**         |  >=2.34   |        2.34.1         | A version control system and command-line utility for downloading packages from GitHub |
+| **Cmake**       |  >=3.19   |        3.22.4         | Cross-platform family of tools designed to build, test and package software            |
+| **Ninja-build** |  >=1.10   |        1.11.0         | Build system                                                                           |
+| **Python3**     |   >=3.7   |        3.11.0         | Scripting language                                                                     |
+| **Pip**         |   >=20    |        23.1.0         | Command line tool for downloading python packages                                      |
+| **LAPACK**      | >=3.11.0  |        3.11.0         | Linear algebra package                                                                 |
+| **OpenBlas**    | >= 0.3.20 |        0.3.30         | Optimize BLAS library                                                                  |
+| **HDF5**        |  >=1.10   |        1.10.7         | High-performance data software-library and file-format                                 |
+| **PlPlot**      | >=5.15.0  |        5.15.0         | Cross-platform, scientific graphics plotting library                                   |
+| **Boost**       |           |                       |                                                                                        |
+| **Gnuplot**     |   >=5.0   |          5.4          | Portable command-line driven graphing utility                                          |
+| **Doxygen**     |  >=1.9.1  |         1.9.1         | documentation generation                                                               |
+| **GTK-4**       |           |                       | n                                                                                      |
 
 You can use following instructions to satisfy the above-mentioned requirements depending upon your system.
-

docs/about/easifemClasses.md

@@ -18,7 +18,7 @@ USE easifemClasses
 
 ## Structure
 
-- [ ] TODO add key-features to ` easifemClasses`
+- [ ] TODO add key-features to `easifemClasses`
 
 Similar to the Base library, the `Classes` library has two directories in the `src` directory:
 
@@ -44,14 +44,14 @@ If you want to implement a class called `XXX_`, then perform following task:
 1. Make a subdirectory `XXX` in `src/modules` and `src/submodules`
 2. In both `XXX` make a subdirectory `XXX/src`
 3. Create a file `modules/XXX/src/XXX_Class.F90` and define a module called `XXX_Class`:
-4. Create submodules  in `submodule/XXX/src/[email protected]` and implement the methods.
+4. Create submodules in `submodule/XXX/src/[email protected]` and implement the methods.
 
 ```fortran
 MODULE XXX_Class
 !! Use modules
 PRIVATE
 !!  Define class here
-END MODULE XXX_Class 
+END MODULE XXX_Class
 ```
 
 :::