Skip to content

Commit 7e4d6ce

Browse files
Merge pull request #1 from GabLeRoux/master
improve readme and add MIT license ✌🏻
2 parents 96fbd57 + e07eacf commit 7e4d6ce

File tree

2 files changed

+38
-17
lines changed

2 files changed

+38
-17
lines changed

LICENSE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
The MIT License (MIT)
2+
Copyright (c) 2018 Gustavo Wiederhecker
3+
4+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
5+
6+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
7+
8+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,37 @@
11
# ToPython
22

3-
Package to convert MATHEMATICA expressions to Python (Numpy);
3+
Mathematica package to convert [MATHEMATICA](https://www.wolfram.com/mathematica/) expressions to Python [Numpy](http://www.numpy.org/)
44

5-
INPUT ARGUMENTS;
6-
x: your mathematica expression, it can be numbers, literals,
7-
complexes or lists;
8-
numpy\[LetterSpace]prefix: string defining your Numpy import prefix,
5+
## Input arguments
6+
7+
`x`: your mathematica expression, it can be `numbers`, `literals`,
8+
`complexes` or `lists`;
9+
`numpy\[LetterSpace]prefix`: string defining your Numpy `import` prefix,
910
e.g.:
10-
if your used "import numpy as np", your prefix should be the string
11-
"np"
12-
if your used "from numpy import *", your prefix should be the empty
13-
string ""
14-
;
15-
OUTPUT;
16-
the Numpy python-ready expression (to be copied as a string);
17-
The formatted expression will be copied ot your clipboard, ready to paste on Python;
11+
* if your used `import numpy as np`, your prefix should be the string
12+
`np`
13+
* if your used `from numpy import *`, your prefix should be the empty
14+
string `''`
15+
16+
## Output
17+
18+
* The Numpy python-ready expression (to be copied as a string)
19+
* The formatted expression will be copied to your clipboard, ready to paste to Python
20+
21+
## Installation
22+
23+
To install the package
24+
25+
1. Download it
26+
2. Click on `Mathematica`' `File menu-> Install->From file...`
27+
3. Select the file on your disk
28+
29+
You should be ready to go.
30+
31+
## Disclaimer
1832

19-
Not tested for every possible combination; use at your risk
33+
This has not been tested for every possible combinations of all the things, use at your own risks.
2034

21-
# Installation
35+
## License
2236

23-
To install the package, download it, click on Mathematica' File menu-> Install->From file...
24-
Select the file on your disk and you should be ready to go.
37+
[MIT](LICENSE.md) © [Gustavo Wiederhecker](https://github.com/gwiederhecker)

0 commit comments

Comments
 (0)