Skip to content

Commit 9b74683

Browse files
authored
Removed div tags
1 parent e590c5d commit 9b74683

1 file changed

Lines changed: 1 addition & 11 deletions

File tree

README.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
</p>
44

55
# MLC (Machine Learning Control)
6+
[![Build Status](https://travis-ci.org/Ezetowers/MLC.svg?branch=master)](https://travis-ci.org/Ezetowers/MLC)
67

78
## Table of Contents
89
1. [Abstract](#abstract)
@@ -17,12 +18,10 @@
1718
5. [How To Run MLC](#how_to_run_mlc)
1819
6. [Testing](#testing)
1920

20-
<div id='abstract'/>
2121
## Abstract
2222
MLC is a framework designed to solve chaotic problems related with the field of fluodynamics.
2323
The input of the system it's an script which models a problem. This problem is solved evolving populations, which are groups of non related individuals, through the use of a set of genetic algorithms. Every individual is modeled as a linear combination of diffenrent operators (-,+, sin, cos, exp, etc.).
2424

25-
<div id='project_structure'/>
2625
## Project Structure
2726
* **[MLC](MLC)**: The files inside this path are related with the Python code use
2827
* **[conf](conf)**: Directory where the differents config files of the project are stored. For the moment, the app read config files from this directory, so be sure to persist your desired configuration within them.
@@ -31,19 +30,15 @@ The input of the system it's an script which models a problem. This problem is s
3130
* **[tests](tests)**: Tests related with the project (functional, unit tests, etc.) can be found here.
3231
* **[tools](tools)**: Additional scripts and files are stored in this directory.
3332

34-
<div id='installation'/>
3533
## Installation
3634

37-
<div id='python_engine_and_mlc_python'/>
3835
### Python Engine and MLC Python
3936
Previous versions of MLC ran in MATLAB&reg;. The last version is being ported to Python, so the actual implementation is a hybrid between this two languages.
4037

41-
<div id='matlab_versions_supported'/>
4238
#### MATLAB versions supported
4339
The main program starts running in Python and make calls to MATLAB&reg; when it is needed. To be able to run MATLAB&reg; code inside Python, the module [Python Engine](http://www.mathworks.com/help/matlab/matlab-engine-for-python.html) is used.
4440
Python Engine is available in versions of MATLAB&reg; 2014b and ahead.
4541

46-
<div id='mlc_python'/>
4742
#### MLC Python
4843
In order to succesfully run the [Python Engine Module](http://www.mathworks.com/help/matlab/matlab-engine-for-python.html), Python must compiled in a special way. For more details, the [Python Engine Documentation](http://www.mathworks.com/help/matlab/matlab_external/system-requirements-for-matlab-engine-for-python.html) can be inspected.
4944
A pre-compiled version of Python can be found in the following [link](https://drive.google.com/file/d/0B1yBBZBneUgZb2gwb1hOTDF4Tjg/view). The file it's a .deb package and it was succesfully installed in the following operating systems:
@@ -87,17 +82,14 @@ The new Python is installed in the directory **/opt/mlc-python-2.7.11**. This ve
8782
* **/opt/mlc-python-2.7.11/bin/mlc_pip**: All new Python dependencies that would like to be installed, must be installed with this version of pip. In other case, the dependencies must be built and installed with the mlc_python script.
8883
* **/opt/mlc-python-2.7.11/bin/mlc_nosetests**: The project tests must be executed with the following script.
8984

90-
<div id='configuration'/>
9185
## Configuration
9286
*All the configuration files of the application can be found in the [conf directory](conf). **MLC consumes them directly
9387
from there,*** so beware of make all your desired changes in files inside this folder.
9488

95-
<div id='parameters'/>
9689
### Parameters
9790
All the parameters associated with the MLC must be set in the file [configuration.conf](conf/configuration.conf).
9891
A short description of every parameter and also the valid values supported can be found in the [Wiki](https://github.com/Ezetowers/taller3_final/wiki/Configuration-Parameters).
9992

100-
<div id='logging'/>
10193
### Logging
10294
MLC provides log facilities based on the [Python Logging Module](https://docs.python.org/2/library/logging.html). The application consumes the file [logging.conf](conf/logging.conf) in order to retrieve the different log configuration available. The present available log configuration are the following:
10395
* **console**: Redirects the output of the MLC to standard output. The log-level is set to *DEBUG*.
@@ -109,7 +101,6 @@ content is stored in */tmp/mlc.log*.
109101
The log configuration can be changed modifying the parameter **logmode** in the **LOGGING** section of the
110102
[config file](conf/configuration.conf). Take care to put a valid value in order to avoid problems running the application.
111103

112-
<div id='how_to_run_mlc'/>
113104
## How to Run MLC
114105
For the moment, MLC does not receive any parameters to run. As it was said in previous sections, it retrieves the
115106
desired configuration from the [configuration file](conf/configuration.conf) and redirects the output obeying the rules dictated by the [logging config file](conf/logging.conf).
@@ -120,7 +111,6 @@ follows:
120111
user@hostname:/path/to/MLC_Project$ ./opt/mlc-python-2.7.11/bin/mlc_python main.py
121112
```
122113

123-
<div id='testing'/>
124114
## Testing
125115
By default, tests (Unit tests, Integration tests, Smoke tests, etc.) are placed in the folder [test](tests).
126116
The tests are designed using the [Python Unittest Module](https://docs.python.org/2/library/unittest.html). To avoid

0 commit comments

Comments
 (0)