search

megalut / sewpy

Source Extractor Wrapper for Python
GNU General Public License v3.0
22 stars 11 forks source link

How do you install sewpy? #11

Closed reikonakajima closed 10 years ago

reikonakajima commented 10 years ago

If you can put in a short description in the README, that would be great. I'm assuming it's

> python setup.py
reikonakajima commented 10 years ago 
> python setup.py install --user

worked for me on the Euclid machines.

reikonakajima commented 10 years ago

I'll edit (on the master branch) the README file. I'll let you know when I"m done---please take a look then.

mtewes commented 10 years ago

Right now the README says "To learn more about how to install and use sewpy, proceed to its documentation."

reikonakajima commented 10 years ago

We can a single line instead of making them go to an extra step.

reikonakajima commented 10 years ago

...I mean, "We can ADD a single line..."

mtewes commented 10 years ago

Maybe we want to make an INSTALL.rst file (standard of pypi, to be checked), and then include this into the sphinx doc (in the same way that the current README.rst gets included into the sphinx doc).

reikonakajima commented 10 years ago

Oh, OK. But it's only a single line, no? Or is there more?

mtewes commented 10 years ago

Hmm, I think that it would be useful to point to at least the two options currently in the doc. What about a "oneliner" at the end of the README, and "for more, see INSTALL.rst" ?

reikonakajima commented 10 years ago

The sewpy.readthedocs.org page doesn't tell me the setup procedure. I know I'm not very Python-saavy, and that's why I'm asking for these silly requests...

Hmm, I think that it would be useful to point to at least the two options currently in the doc. What about a "oneliner" at the end of the README, and "for more, see INSTALL.rst" ?

Sure.

reikonakajima commented 10 years ago

By the way, what should go in INSTALL.rst?

mtewes commented 10 years ago

Do you mean that http://sewpy.readthedocs.org/en/latest/installation.html is too obscure ? In any case, moving this to INSTALL will help finding this page.

I think we want there more or less what is currently on this sphinx page.

reikonakajima commented 10 years ago

http://sewpy.readthedocs.org/en/latest/installation.html

Ah, but the README.rst doesn't point to that page. It only points to http://sewpy.readthedocs.org which is why I was confused, I guess.

mtewes commented 10 years ago

... well, there is a menu, and the first chapter is "Installing sewpy" :) But ok, let's make this more visible.

reikonakajima commented 10 years ago

It's two steps to get to the installation command. I don't think we need an INSTALL file, but a clear link to the installation.html page in the README file, plus a one-liner (which should work for most people). I'll do that on the master, if that's ok with you.

mtewes commented 10 years ago

Yes, sure.

reikonakajima commented 10 years ago

OK, done. Would you mind taking a look? Thanks.

mtewes commented 10 years ago

Yes, I'll have a look now. I couln't find any firm instructions for a good INSTALL file. It seems that it's just a commonly used convention. I thought that it was related to pypi, but it seems that it's not. We probably want to get everything working with pypi once sewpy is more mature: https://packaging.python.org/en/latest/distributing.html

mtewes commented 10 years ago

Are you fixing the rst format or should I do this ? I'd like to make a few tiny rephrasings, so that it integrates better when this page is seen as part of the sphinx doc (see the source of the index.rst for the "include" command)

reikonakajima commented 10 years ago

I wasn't sure how to edit rst... sorry if it didn't turn out as I intended (it worked on my emacs screen). Please go ahead and edit as you see fit.

mtewes commented 10 years ago

OK, I'll do it. It looks weird on the github front page, that's why I noticed.

mtewes commented 10 years ago

Done –– ok for you ? The formatting errors where related to missing indentation for the first (blank) line in the bash code block.

reikonakajima commented 10 years ago

Done –– ok for you ?

Yes, nice and concise.

The formatting errors where related to missing indentation for the first (blank) line in the bash code block.

Ah, thanks. I didn't know you needed to indent the first blank line. I'll probably have to re-edit some of the stuff I've recently edited in megalut!

reikonakajima commented 10 years ago

I'll probably have to re-edit some of the stuff I've recently edited in megawatt!

I checked---They were left intact.

Thanks for your checks. I'll close this issue now.

kuntzer commented 10 years ago

Why did the name of MegaLUT changed to megawatt in the quote ? :astonished:

reikonakajima commented 10 years ago

Ah, it's due to my stupid spell checker on my Mac. Gah!

kuntzer commented 10 years ago

ahah