From 5f4953ea6d13d67d28832a115e8743e7ab4fc1fb Mon Sep 17 00:00:00 2001 From: Sterling Harper Date: Sat, 1 Oct 2016 17:05:09 -0400 Subject: [PATCH] Shorten Filter.get_pandas_dataframe docstrings --- openmc/filter.py | 45 --------------------------------------------- 1 file changed, 45 deletions(-) diff --git a/openmc/filter.py b/openmc/filter.py index 854172328d..d11af96f52 100644 --- a/openmc/filter.py +++ b/openmc/filter.py @@ -354,10 +354,6 @@ class Filter(with_metaclass(FilterMeta, object)): columns annotated by filter bin information. This is a helper method for :meth:`Tally.get_pandas_dataframe`. - This capability has been tested for Pandas >=0.13.1. However, it is - recommended to use v0.16 or newer versions of Pandas since this method - uses Pandas' Multi-index functionality. - Parameters ---------- data_size : Integral @@ -380,23 +376,6 @@ class Filter(with_metaclass(FilterMeta, object)): the total number of bins in the corresponding tally, with the filter bin appropriately tiled to map to the corresponding tally bins. - For 'cell', 'cellborn', 'surface', 'material', and 'universe' - filters, the DataFrame includes a single column with the cell, - surface, material or universe ID corresponding to each filter bin. - - For 'distribcell' filters, the DataFrame either includes: - - 1. a single column with the cell instance IDs (without summary info) - 2. separate columns for the cell IDs, universe IDs, and lattice IDs - and x,y,z cell indices corresponding to each (distribcell paths). - - For 'energy' and 'energyout' filters, the DataFrame includes one - column for the lower energy bound and one column for the upper - energy bound for each filter bin. - - For 'mesh' filters, the DataFrame includes three columns for the - x,y,z mesh cell indices corresponding to each filter bin. - Raises ------ ImportError @@ -571,10 +550,6 @@ class SurfaceFilter(IntegralFilter): columns annotated by filter bin information. This is a helper method for :meth:`Tally.get_pandas_dataframe`. - This capability has been tested for Pandas >=0.13.1. However, it is - recommended to use v0.16 or newer versions of Pandas since this method - uses Pandas' Multi-index functionality. - Parameters ---------- data_size : Integral @@ -730,10 +705,6 @@ class MeshFilter(Filter): columns annotated by filter bin information. This is a helper method for :meth:`Tally.get_pandas_dataframe`. - This capability has been tested for Pandas >=0.13.1. However, it is - recommended to use v0.16 or newer versions of Pandas since this method - uses Pandas' Multi-index functionality. - Parameters ---------- data_size : Integral @@ -924,10 +895,6 @@ class EnergyFilter(Filter): columns annotated by filter bin information. This is a helper method for :meth:`Tally.get_pandas_dataframe`. - This capability has been tested for Pandas >=0.13.1. However, it is - recommended to use v0.16 or newer versions of Pandas since this method - uses Pandas' Multi-index functionality. - Parameters ---------- data_size : Integral @@ -1072,10 +1039,6 @@ class DistribcellFilter(Filter): columns annotated by filter bin information. This is a helper method for :meth:`Tally.get_pandas_dataframe`. - This capability has been tested for Pandas >=0.13.1. However, it is - recommended to use v0.16 or newer versions of Pandas since this method - uses Pandas' Multi-index functionality. - Parameters ---------- data_size : Integral @@ -1332,10 +1295,6 @@ class PolarFilter(Filter): columns annotated by filter bin information. This is a helper method for :meth:`Tally.get_pandas_dataframe`. - This capability has been tested for Pandas >=0.13.1. However, it is - recommended to use v0.16 or newer versions of Pandas since this method - uses Pandas' Multi-index functionality. - Parameters ---------- data_size : Integral @@ -1414,10 +1373,6 @@ class AzimuthalFilter(Filter): columns annotated by filter bin information. This is a helper method for :meth:`Tally.get_pandas_dataframe`. - This capability has been tested for Pandas >=0.13.1. However, it is - recommended to use v0.16 or newer versions of Pandas since this method - uses Pandas' Multi-index functionality. - Parameters ---------- data_size : Integral