|
1 | 1 | <!DOCTYPE html> |
2 | | -<html class="writer-html5" lang="en" > |
| 2 | +<html class="writer-html5" lang="en"> |
3 | 3 | <head> |
4 | | - <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> |
| 4 | + <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> |
5 | 5 |
|
6 | 6 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
7 | 7 | <title>Installation — MEDfl 0.1.0 documentation</title> |
8 | | - <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
9 | | - <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |
10 | | - <link rel="stylesheet" href="_static/custom.css" type="text/css" /> |
11 | | - <link rel="stylesheet" href="_static/css/custom.css" type="text/css" /> |
12 | | - <link rel="stylesheet" href="_static/dark_mode_css/general.css" type="text/css" /> |
13 | | - <link rel="stylesheet" href="_static/dark_mode_css/dark.css" type="text/css" /> |
| 8 | + <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> |
| 9 | + <link rel="stylesheet" type="text/css" href="_static/css/theme.css" /> |
| 10 | + <link rel="stylesheet" type="text/css" href="_static/custom.css" /> |
| 11 | + <link rel="stylesheet" type="text/css" href="_static/css/custom.css" /> |
| 12 | + <link rel="stylesheet" type="text/css" href="_static/dark_mode_css/general.css" /> |
| 13 | + <link rel="stylesheet" type="text/css" href="_static/dark_mode_css/dark.css" /> |
| 14 | + |
| 15 | + |
14 | 16 | <!--[if lt IE 9]> |
15 | 17 | <script src="_static/js/html5shiv.min.js"></script> |
16 | 18 | <![endif]--> |
|
27 | 29 | <link rel="index" title="Index" href="genindex.html" /> |
28 | 30 | <link rel="search" title="Search" href="search.html" /> |
29 | 31 | <link rel="next" title="Documentation" href="Documentation.html" /> |
30 | | - <link rel="prev" title="Welcome to the MEDfl documentation!" href="index.html" /> |
| 32 | + <link rel="prev" title="Welcome to the MEDfl Documentation" href="index.html" /> |
31 | 33 | </head> |
32 | 34 |
|
33 | 35 | <body class="wy-body-for-nav"> |
|
40 | 42 |
|
41 | 43 | <a href="index.html"> |
42 | 44 |
|
43 | | - <img src="_static/MEDomics.png" class="logo" alt="Logo"/> |
| 45 | + <img src="_static/medfl_logo.png" class="logo" alt="Logo"/> |
44 | 46 | </a> |
45 | 47 | <div role="search"> |
46 | 48 | <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
|
50 | 52 | </form> |
51 | 53 | </div> |
52 | 54 | </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> |
53 | | - <p class="caption" role="heading"><span class="caption-text">Getting started</span></p> |
| 55 | + <p class="caption" role="heading"><span class="caption-text">Getting Started</span></p> |
54 | 56 | <ul class="current"> |
55 | 57 | <li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul> |
56 | | -<li class="toctree-l2"><a class="reference internal" href="#python-installation">Python installation</a></li> |
57 | | -<li class="toctree-l2"><a class="reference internal" href="#package-installation">Package Installation</a></li> |
58 | | -<li class="toctree-l2"><a class="reference internal" href="#mysql-db-configuration">MySQL DB Configuration</a></li> |
| 58 | +<li class="toctree-l2"><a class="reference internal" href="#python-requirements">Python Requirements</a></li> |
| 59 | +<li class="toctree-l2"><a class="reference internal" href="#package-installation-for-users">Package Installation (For Users)</a></li> |
| 60 | +<li class="toctree-l2"><a class="reference internal" href="#package-installation-for-contributors">Package Installation (For Contributors)</a></li> |
| 61 | +<li class="toctree-l2"><a class="reference internal" href="#database-configuration">Database Configuration</a></li> |
59 | 62 | </ul> |
60 | 63 | </li> |
61 | 64 | <li class="toctree-l1"><a class="reference internal" href="Documentation.html">Documentation</a></li> |
62 | | -<li class="toctree-l1"><a class="reference internal" href="configuration_file.html">Configuration File</a></li> |
63 | 65 | </ul> |
64 | | -<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p> |
| 66 | +<p class="caption" role="heading"><span class="caption-text">Simulation Tutorials</span></p> |
65 | 67 | <ul> |
66 | | -<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Introduction</a></li> |
67 | | -<li class="toctree-l1"><a class="reference internal" href="tutorials.html#database-management">Database management</a></li> |
68 | | -<li class="toctree-l1"><a class="reference internal" href="tutorials.html#netmanager">NetManager</a></li> |
69 | | -<li class="toctree-l1"><a class="reference internal" href="tutorials.html#transfer-learning">Transfer Learning</a></li> |
70 | | -<li class="toctree-l1"><a class="reference internal" href="tutorials.html#learning-manager">Learning Manager</a></li> |
71 | | -<li class="toctree-l1"><a class="reference internal" href="tutorials.html#learning-results">Learning Results</a></li> |
72 | | -<li class="toctree-l1"><a class="reference internal" href="tutorials.html#model-choice">Model choice</a></li> |
| 68 | +<li class="toctree-l1"><a class="reference internal" href="simulation_tutorials.html">Introduction</a></li> |
| 69 | +<li class="toctree-l1"><a class="reference internal" href="simulation_tutorials.html#database-management">Database management</a></li> |
| 70 | +<li class="toctree-l1"><a class="reference internal" href="simulation_tutorials.html#netmanager">NetManager</a></li> |
| 71 | +<li class="toctree-l1"><a class="reference internal" href="simulation_tutorials.html#transfer-learning">Transfer Learning</a></li> |
| 72 | +<li class="toctree-l1"><a class="reference internal" href="simulation_tutorials.html#learning-manager">Learning Manager</a></li> |
| 73 | +<li class="toctree-l1"><a class="reference internal" href="simulation_tutorials.html#learning-results">Learning Results</a></li> |
| 74 | +<li class="toctree-l1"><a class="reference internal" href="simulation_tutorials.html#model-choice">Model choice</a></li> |
| 75 | +<li class="toctree-l1"><a class="reference internal" href="simulation_tutorials_complete.html">MEDfl Complete Tutorial (Simulation)</a></li> |
73 | 76 | </ul> |
74 | | -<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> |
| 77 | +<p class="caption" role="heading"><span class="caption-text">🌍 Real-World Tutorials</span></p> |
| 78 | +<ul> |
| 79 | +<li class="toctree-l1"><a class="reference internal" href="rw_tutorial_complete.html">Real-world Federated Learning Tutorial</a></li> |
| 80 | +</ul> |
| 81 | +<p class="caption" role="heading"><span class="caption-text">Contents</span></p> |
75 | 82 | <ul> |
76 | 83 | <li class="toctree-l1"><a class="reference internal" href="modules.html">MEDfl</a></li> |
77 | 84 | </ul> |
|
102 | 109 |
|
103 | 110 | <section id="installation"> |
104 | 111 | <h1>Installation<a class="headerlink" href="#installation" title="Permalink to this heading"></a></h1> |
105 | | -<section id="python-installation"> |
106 | | -<h2>Python installation<a class="headerlink" href="#python-installation" title="Permalink to this heading"></a></h2> |
107 | | -<p>The MEDfl package requires <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">3.9</span></code> or more to be run. If you don’t have it installed on your machine, check out the following link <a class="reference external" href="https://www.python.org/downloads/">Python</a> |
108 | | -It also requires MySQL database</p> |
| 112 | +<section id="python-requirements"> |
| 113 | +<h2>Python Requirements<a class="headerlink" href="#python-requirements" title="Permalink to this heading"></a></h2> |
| 114 | +<p>The MEDfl package requires <strong>Python 3.9+</strong>. |
| 115 | +If you do not have Python installed on your machine, you can download it from: |
| 116 | +<a class="reference external" href="https://www.python.org/downloads/">Python</a></p> |
| 117 | +<p>MEDfl uses <strong>SQLite</strong> as its default database engine. |
| 118 | +SQLite requires <strong>no setup and no configuration</strong> — it works automatically using a local <cite>.db</cite> file generated by MEDfl.</p> |
109 | 119 | </section> |
110 | | -<section id="package-installation"> |
111 | | -<h2>Package Installation<a class="headerlink" href="#package-installation" title="Permalink to this heading"></a></h2> |
112 | | -<p>For now, you can install the <code class="docutils literal notranslate"><span class="pre">MEDfl</span></code> package as follows:</p> |
| 120 | +<section id="package-installation-for-users"> |
| 121 | +<h2>Package Installation (For Users)<a class="headerlink" href="#package-installation-for-users" title="Permalink to this heading"></a></h2> |
| 122 | +<p>If you simply want to <strong>use MEDfl</strong>, you can install the package directly from PyPI:</p> |
| 123 | +<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>MEDfl |
| 124 | +</pre></div> |
| 125 | +</div> |
| 126 | +<p>This installs the latest stable release and allows you to start using MEDfl immediately.</p> |
| 127 | +</section> |
| 128 | +<section id="package-installation-for-contributors"> |
| 129 | +<h2>Package Installation (For Contributors)<a class="headerlink" href="#package-installation-for-contributors" title="Permalink to this heading"></a></h2> |
| 130 | +<p>If you want to <strong>collaborate</strong>, contribute, or modify the MEDfl source code, install it from GitHub in editable mode:</p> |
113 | 131 | <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/MEDomics-UdeS/MEDfl.git |
114 | 132 | <span class="nb">cd</span><span class="w"> </span>MEDfl |
115 | 133 | pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>. |
116 | 134 | </pre></div> |
117 | 135 | </div> |
| 136 | +<p>This setup allows you to modify the package locally while testing new features.</p> |
118 | 137 | </section> |
119 | | -<section id="mysql-db-configuration"> |
120 | | -<h2>MySQL DB Configuration<a class="headerlink" href="#mysql-db-configuration" title="Permalink to this heading"></a></h2> |
121 | | -<p>MEDfl requires a MySQL DB connection, and this is in order to allow users to work with their own tabular datasets. We have created a bash script to install and configure a MySQL DB with phpMyAdmin monitoring system. Run the following command, then change your credentials in the MEDfl/scripts/base.py file:</p> |
122 | | -<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>bash<span class="w"> </span>MEDfl/scripts/setup_mysql.sh |
123 | | -</pre></div> |
124 | | -</div> |
| 138 | +<section id="database-configuration"> |
| 139 | +<h2>Database Configuration<a class="headerlink" href="#database-configuration" title="Permalink to this heading"></a></h2> |
| 140 | +<p>No database configuration is required.</p> |
| 141 | +<p>MEDfl uses <strong>SQLite</strong>, a lightweight and reliable file-based database system. |
| 142 | +A local <cite>.db</cite> file is created automatically when you initialize the MEDfl environment or use any functionality requiring storage. |
| 143 | +No external server, setup script, or credentials are needed.</p> |
125 | 144 | </section> |
126 | 145 | </section> |
127 | 146 |
|
128 | 147 |
|
129 | 148 | </div> |
130 | 149 | </div> |
131 | 150 | <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
132 | | - <a href="index.html" class="btn btn-neutral float-left" title="Welcome to the MEDfl documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| 151 | + <a href="index.html" class="btn btn-neutral float-left" title="Welcome to the MEDfl Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
133 | 152 | <a href="Documentation.html" class="btn btn-neutral float-right" title="Documentation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
134 | 153 | </div> |
135 | 154 |
|
|
0 commit comments