search

MoonRaker / pvlib-python

A set of documented functions for simulating the performance of photovoltaic energy systems.
BSD 3-Clause "New" or "Revised" License
0 stars 0 forks source link

readthedocs #4

Open wholmgren opened 8 years ago

wholmgren commented 8 years ago

The lastest pvlib-python docs compile fine on RTD (I just forced a rebuild), so I think it's likely to be something with your configuration. RTD has some log files for you to read, though they often have a bunch of errors that don’t actually cause problems with the docs.

Here's the link to the latest build of the main repo on RTD:

https://readthedocs.org/projects/pvlib-python/builds/3422258/

Also, please add something to the comparison_pvlib_matlab.rst file, and make a new whatsnew file, probably for version 0.3.0. You’ll also want to change the version in pvlib/version.py.

MoonRaker commented 8 years ago

I wasn't sure what the issue was because it had said they had passed. I see now that looking through the log files that I needed to update the setup.py to include siphon and netcdf4 library. However, it is having an issue with the netcdf4 package because it has several requirements including hdf5. It seems that these are not easily installed apart from using the conda packages. netcdf is required for siphon and after looking through their code I am not sure how they deal with this issue. I have tried using a requirements file with no success.

wholmgren commented 8 years ago

Ok, don't worry about RTD for now, but please do make the other changes. I have some poorly formed ideas about this for RTD and I might look into it at some point if I get a minute.

MoonRaker commented 8 years ago

Alright. I have already made the other changes and will let you know if I figure it out.

MoonRaker commented 8 years ago

@dopplershift Would be willing to share, if even briefly, how siphon is set up to build its documentation on RTD and get around the netcdf4 importerror? I have the same issue when trying to build the siphon docs from my fork.

dopplershift commented 8 years ago

I don't, which is apparently now a problem (it errored before, but didn't kill the build of the docs). See Unidata/siphon#62, which is trying to fix it. I'm planning on removing the hard NetCDF4 requirement (which is not a forced import anywhere so shouldn't actually be required). This should be done this week, since I'd like my own docs to build. :)

MoonRaker commented 8 years ago

Got it, thanks. We'll keep an eye on the solution you come up with.

dopplershift commented 8 years ago

I've moved netcdf to be a requirement for the 'tests' and 'netcdf' extras on the package. Do you guys need a release or can you work with git?

MoonRaker commented 8 years ago

Git is fine, we can do without a release for now. We are still working out our netcdf requirements too. Thanks for the update.